CHANGES.md

About

HID DigitalPersona WebSdk 2023 version.

DigitalPersona Web SDK (DP WebSDK) is a Windows service and a user agent application running locally on a user device and providing access to authentication devices like fingerprint readers, smartcard readers etc. These devices are not directly accessible from Javascript running in a browser.

Breaking changes

• ifvisible module was removed as it was not used by WebSdk and available as npm packeage.

• WebChannelClientImpl method setReconnectTimer() renamed to startReconnectTimer()

• WebChannelClientImpl method resetReconnectTimer() renamed to stopReconnectTimer()

• WebChannelClientImpl WebChannelClientImpl.fireConnectionFailed() method will not attempt to reconnect if connection failed. We fire event (with WebChannelClientImpl.onConnectionFailed) to client so client should decide to re-try establish connection. If code is used from serviceWokers then there is no window object to check if window is active.

    const client: WebChannelClientImpl = new WebChannelClientImpl();

    client.onConnectionFailed = () => {
        if (window.parent.parent.document.hasFocus()) {
            client.setReconnectTimer();
        }
    }

The call client.setReconnectTimer() will try reconnect to server tree times.

• In previous version WebChannelClientImpl subscribed to blur and focus events in contructor. When event happend WebChannelClientImpl was fiering sdk.focusChanged custom event. The new version of the WebSdk no longer tracks window focus events. If necessary, this can be done on the client side.

      const client: WebChannelClientImpl = new WebChannelClientImpl();
      listenFocusBlurEvents();
  
      function listenFocusBlurEvents() {
        window.parent.parent.addEventListener("blur", function () {
            client.resetReconnectTimer();
            notifyFocusChanged(false);
        });
        window.parent.parent.addEventListener("focus", function () {
            notifyFocusChanged(true);
        });
      }
  
      client.onConnectionSucceed = () => {
          if (window.parent.parent.document.hasFocus()) {
              notifyFocusChanged(true);
          } else {
              notifyFocusChanged(false);
          }
      }
  
      function notifyFocusChanged(isFocused: boolean) {
          if (client.isConnected()) {
              client.sendData(JSON.stringify({ type: 'sdk.focusChanged', data: isFocused, }));
          }
      }

Minor changes

• Remove unsed WebSdk.Promise. This was not used for a log time.

• Private variable WebSdk renamed to envSdk. WebSdk name was used for everything.

• Remove property 'path' from WebChannelClient. It's comming from user already and is duplicate of user information

• WebSdk.IWebChannelClient.sendDataBin type is (data: number[]) => void; not (data: ArrayBuffer) => void (see AESEncryption())

• Configurator session is now a private member and can be accessed with public async function configurator.getSessionStorageData().

• configurator.ensureLoaded() will throw an error instead of returning object with error member.

• Add callback types

Original API file

declare module WebSdk {

    interface IWebChannelClient {
        /**
        * Connects to the server with available configuration. If connection failed, onConnectionFailed callback will be called.
        */
        connect: () => void;
        
        /**
        * Dicconnects from the server or stops attempts to restore lost connection.
        */
        disconnect: () => void;

        /**
        * Callback invoked when client cannot connect to the server (because has no data in local storage or this data is obsolete).
        */
        onConnectionFailed: () => void;

        /**
        * Callback invoked when client successfully connected to the server.
        */
        onConnectionSucceed: () => void;

        /**
        * Callback invoked when binary data  is received from the server.
        * @param {ArrayBuffer} data
        */
        onDataReceivedBin: (data: ArrayBuffer) => void;

        /**
        * Callback invoked when binary data  is received from the server.
        * @param {string} data
        */
        onDataReceivedTxt: (data: string) => void;

        /**
        * Sends binary data to the server.
        * @param {number[]} data
        */
        sendDataBin: (data: number[]) => void;

        /**
        * Sends text data to the server.
        * @param {string} data
        */
        sendDataTxt: (data: string) => void;

        /**
        * Returns current connection state of the client.
        */
        isConnected(): boolean;
    }

    class WebChannelOptions {
        constructor(options: Object);

        /*
        * If true debug logs are outputted to browser Console
        */
        debug(): boolean;
        debug(value: boolean): void;

        /*
        * Version of WebSdk channel (1,2,3,etc.). This should be one of WebSdkEncryptionSupport numbers.
        */
        version(): number;
        version(value: number): void;
    }

    class WebChannelClient implements IWebChannelClient {
        /**
        * Creates WebChannelClient
        * @param {string} path - the path that identifies registered WebSdk plugin
        * @param {WebChannelOptions} options - the options to configure web channel
        */
        constructor(path: string, options?: WebChannelOptions);

        connect(): Promise<void>;
        disconnect(): Promise<void>;

        onConnectionFailed(): void;
        onConnectionSucceed(): void;
        onDataReceivedBin(data: ArrayBuffer): void;
        onDataReceivedTxt(data: string): void;

        sendDataBin(data: number[]): void;
        sendDataTxt(data: string): void;

        isConnected(): boolean;
    }
}