@ukeyfe/hardware-core 1.1.13

package/src/events/ui-request.ts

@@ -0,0 +1,205 @@
+import type { PROTO } from '../constants';
+import type { Device } from '../types';
+import type { DeviceButtonRequest } from './device';
+import type { MessageFactoryFn } from './utils';
+
+export const UI_EVENT = 'UI_EVENT';
+
+export const UI_REQUEST = {
+  REQUEST_PIN: 'ui-request_pin',
+  INVALID_PIN: 'ui-invalid_pin',
+  REQUEST_BUTTON: 'ui-button',
+  REQUEST_PASSPHRASE: 'ui-request_passphrase',
+  REQUEST_PASSPHRASE_ON_DEVICE: 'ui-request_passphrase_on_device',
+  REQUEST_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE:
+    'ui-request_select_device_in_bootloader_for_web_device',
+
+  CLOSE_UI_WINDOW: 'ui-close_window',
+  CLOSE_UI_PIN_WINDOW: 'ui-close_pin_window',
+  DEVICE_PROGRESS: 'ui-device_progress',
+
+  BLUETOOTH_PERMISSION: 'ui-bluetooth_permission',
+  BLUETOOTH_UNSUPPORTED: 'ui-bluetooth_unsupported',
+  BLUETOOTH_POWERED_OFF: 'ui-bluetooth_powered_off',
+
+  BLUETOOTH_CHARACTERISTIC_NOTIFY_CHANGE_FAILURE:
+    'ui-bluetooth_characteristic_notify_change_failure',
+  LOCATION_PERMISSION: 'ui-location_permission',
+  LOCATION_SERVICE_PERMISSION: 'ui-location_service_permission',
+
+  FIRMWARE_PROCESSING: 'ui-firmware-processing',
+  FIRMWARE_PROGRESS: 'ui-firmware-progress',
+  FIRMWARE_TIP: 'ui-firmware-tip',
+
+  PREVIOUS_ADDRESS_RESULT: 'ui-previous_address_result',
+
+  WEB_DEVICE_PROMPT_ACCESS_PERMISSION: 'ui-web_device_prompt_access_permission',
+
+  BOOTLOADER: 'ui-device_bootloader_mode',
+  NOT_IN_BOOTLOADER: 'ui-device_not_in_bootloader_mode',
+  REQUIRE_MODE: 'ui-device_require_mode',
+  NOT_INITIALIZE: 'ui-device_not_initialized',
+  SEEDLESS: 'ui-device_seedless',
+  FIRMWARE_OLD: 'ui-device_firmware_old',
+  FIRMWARE_NOT_SUPPORTED: 'ui-device_firmware_unsupported',
+  FIRMWARE_NOT_COMPATIBLE: 'ui-device_firmware_not_compatible',
+  FIRMWARE_NOT_INSTALLED: 'ui-device_firmware_not_installed',
+  NOT_USE_UKEY_DEVICE: 'ui-device_please_use_ukey_device',
+} as const;
+
+export interface UiRequestWithoutPayload {
+  type:
+    | typeof UI_REQUEST.CLOSE_UI_WINDOW
+    | typeof UI_REQUEST.CLOSE_UI_PIN_WINDOW
+    | typeof UI_REQUEST.BLUETOOTH_PERMISSION
+    | typeof UI_REQUEST.BLUETOOTH_UNSUPPORTED
+    | typeof UI_REQUEST.BLUETOOTH_POWERED_OFF
+    | typeof UI_REQUEST.BLUETOOTH_CHARACTERISTIC_NOTIFY_CHANGE_FAILURE
+    | typeof UI_REQUEST.LOCATION_PERMISSION
+    | typeof UI_REQUEST.LOCATION_SERVICE_PERMISSION
+    | typeof UI_REQUEST.FIRMWARE_PROCESSING
+    | typeof UI_REQUEST.WEB_DEVICE_PROMPT_ACCESS_PERMISSION;
+  payload?: typeof undefined;
+}
+
+export interface UiRequestFirmwareProgressing {
+  type: typeof UI_REQUEST.FIRMWARE_PROCESSING;
+  payload: {
+    type: 'firmware' | 'ble' | 'bootloader' | 'resource';
+  };
+}
+
+export type UiRequestDeviceAction = {
+  type: typeof UI_REQUEST.REQUEST_PIN;
+  payload: {
+    device: Device;
+    type?: PROTO.PinMatrixRequestType | 'ButtonRequest_PinEntry' | 'ButtonRequest_AttachPin';
+  };
+};
+
+export interface UiRequestButton {
+  type: typeof UI_REQUEST.REQUEST_BUTTON;
+  payload: DeviceButtonRequest['payload'];
+}
+
+export interface UiRequestPassphrase {
+  type: typeof UI_REQUEST.REQUEST_PASSPHRASE;
+  payload: {
+    device: Device;
+    passphraseState?: string;
+    existsAttachPinUser?: boolean;
+  };
+}
+
+export interface UiRequestPassphraseOnDevice {
+  type: typeof UI_REQUEST.REQUEST_PASSPHRASE_ON_DEVICE;
+  payload: {
+    device: Device;
+    passphraseState?: string;
+  };
+}
+
+export interface UiRequestSelectDeviceInBootloaderForWebDevice {
+  type: typeof UI_REQUEST.REQUEST_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE;
+  payload: {
+    device: Device;
+  };
+}
+
+export interface FirmwareProcessing {
+  type: typeof UI_REQUEST.FIRMWARE_PROCESSING;
+  payload: {
+    type: 'firmware' | 'ble' | 'bootloader' | 'resource';
+  };
+}
+
+export type IFirmwareUpdateProgressType = 'transferData' | 'installingFirmware';
+export interface FirmwareProgress {
+  type: typeof UI_REQUEST.FIRMWARE_PROGRESS;
+  payload: {
+    device: Device;
+    progress: number;
+    progressType: IFirmwareUpdateProgressType;
+  };
+}
+
+export interface FirmwareTip {
+  type: typeof UI_REQUEST.FIRMWARE_TIP;
+  payload: {
+    device: Device;
+    data: { message: string };
+  };
+}
+
+export interface DeviceProgress {
+  type: typeof UI_REQUEST.DEVICE_PROGRESS;
+  payload: {
+    progress?: number;
+  };
+}
+
+export interface PreviousAddressResult {
+  type: typeof UI_REQUEST.PREVIOUS_ADDRESS_RESULT;
+  payload: {
+    device: Device;
+    data: {
+      address?: string;
+      path?: string;
+    };
+  };
+}
+
+export type UiEvent =
+  | UiRequestWithoutPayload
+  | UiRequestDeviceAction
+  | UiRequestButton
+  | UiRequestPassphraseOnDevice
+  | UiRequestPassphrase
+  | UiRequestSelectDeviceInBootloaderForWebDevice
+  | FirmwareProcessing
+  | UiRequestSelectDeviceInBootloaderForWebDevice
+  | FirmwareProgress
+  | FirmwareTip
+  | DeviceProgress
+  | PreviousAddressResult;
+
+export enum FirmwareUpdateTipMessage {
+  CheckLatestUiResource = 'CheckLatestUiResource',
+
+  StartDownloadFirmware = 'StartDownloadFirmware',
+  FinishDownloadFirmware = 'FinishDownloadFirmware',
+  DownloadLatestUiResource = 'DownloadLatestUiResource',
+  DownloadFirmware = 'DownloadFirmware',
+  DownloadBleFirmware = 'DownloadBleFirmware',
+  DownloadLatestBootloaderResource = 'DownloadLatestBootloaderResource',
+
+  DownloadLatestUiResourceSuccess = 'DownloadLatestUiResourceSuccess',
+  DownloadFirmwareSuccess = 'DownloadFirmwareSuccess',
+  DownloadBleFirmwareSuccess = 'DownloadBleFirmwareSuccess',
+  DownloadLatestBootloaderResourceSuccess = 'DownloadLatestBootloaderResourceSuccess',
+
+  AutoRebootToBootloader = 'AutoRebootToBootloader',
+  GoToBootloaderSuccess = 'GoToBootloaderSuccess',
+  SelectDeviceInBootloaderForWebDevice = 'SelectDeviceInBootloaderForWebDevice',
+  ConfirmOnDevice = 'ConfirmOnDevice',
+  FirmwareEraseSuccess = 'FirmwareEraseSuccess',
+  StartTransferData = 'StartTransferData',
+  InstallingFirmware = 'InstallingFirmware',
+  UpdateBootloader = 'UpdateBootloader',
+  UpdateBootloaderSuccess = 'UpdateBootloaderSuccess',
+  UpdateSysResource = 'UpdateSysResource',
+  UpdateSysResourceSuccess = 'UpdateSysResourceSuccess',
+  FirmwareUpdating = 'FirmwareUpdating',
+  FirmwareUpdateCompleted = 'FirmwareUpdateCompleted',
+}
+
+export type IFirmwareUpdateTipMessage = `${FirmwareUpdateTipMessage}`;
+
+export type UiEventMessage = UiEvent & { event: typeof UI_EVENT };
+
+export const createUiMessage: MessageFactoryFn<typeof UI_EVENT, UiEvent> = (type, payload) =>
+  ({
+    event: UI_EVENT,
+    type,
+    payload,
+  } as any);

package/src/events/ui-response.ts

@@ -0,0 +1,48 @@
+import { UI_EVENT } from './ui-request';
+import type { MessageFactoryFn } from './utils';
+
+export const UI_RESPONSE = {
+  RECEIVE_PIN: 'ui-receive_pin',
+  RECEIVE_PASSPHRASE: 'ui-receive_passphrase',
+  SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE:
+    'ui-receive_select-device-in-bootloader-for-web-device',
+} as const;
+
+export interface UiResponsePin {
+  type: typeof UI_RESPONSE.RECEIVE_PIN;
+  payload: string;
+}
+
+export interface UiResponsePassphrase {
+  type: typeof UI_RESPONSE.RECEIVE_PASSPHRASE;
+  payload: {
+    value: string;
+    passphraseOnDevice?: boolean;
+    attachPinOnDevice?: boolean;
+    save?: boolean;
+  };
+}
+
+export interface UiResponseSelectDeviceInBootloaderForWebDevice {
+  type: typeof UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE;
+  payload: {
+    deviceId: string;
+  };
+}
+
+export type UiResponseEvent =
+  | UiResponsePin
+  | UiResponsePassphrase
+  | UiResponseSelectDeviceInBootloaderForWebDevice;
+
+export type UiResponseMessage = UiResponseEvent & { event: typeof UI_EVENT };
+
+export const createUiResponse: MessageFactoryFn<typeof UI_EVENT, UiResponseEvent> = (
+  type,
+  payload
+) =>
+  ({
+    event: UI_EVENT,
+    type,
+    payload,
+  } as any);

package/src/events/utils.ts

@@ -0,0 +1,19 @@
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
+  k: infer I
+) => void
+  ? I
+  : never;
+
+export type MessageFactoryFn<Group, Event> = UnionToIntersection<
+  Event extends { type: string }
+    ? Event extends { payload: any }
+      ? (
+          type: Event['type'],
+          payload: Event['payload']
+        ) => { event: Group; type: Event['type']; payload: Event['payload'] }
+      : (
+          type: Event['type'],
+          payload?: undefined
+        ) => { event: Group; type: Event['type']; payload: undefined }
+    : never
+>;

package/src/index.ts

@@ -0,0 +1,67 @@
+import { inject, InjectApi, executeCallback, cleanupCallback } from './inject';
+import { lowLevelInject, LowLevelInjectApi, LowLevelCoreApi } from './lowLevelInject';
+import { topLevelInject } from './topLevelInject';
+import { CoreApi } from './types/api';
+
+export type { LowLevelCoreApi, LowLevelInjectApi } from './lowLevelInject';
+export type { TopLevelInjectApi } from './topLevelInject';
+
+export { default as Core, init as initCore, switchTransport } from './core';
+
+export * from './constants';
+export * from './utils';
+export * from './data-manager';
+export * from './events';
+export * from './types';
+export { whitelist, whitelistExtension } from './data/config';
+export { executeCallback, cleanupCallback };
+
+const HardwareSdk = ({
+  init,
+  call,
+  dispose,
+  eventEmitter,
+  uiResponse,
+  cancel,
+  updateSettings,
+  switchTransport,
+}: InjectApi): CoreApi =>
+  inject({
+    init,
+    call,
+    dispose,
+    eventEmitter,
+    uiResponse,
+    cancel,
+    updateSettings,
+    switchTransport,
+  });
+
+const HardwareSDKLowLevel = ({
+  init,
+  call,
+  dispose,
+  eventEmitter,
+  addHardwareGlobalEventListener,
+  uiResponse,
+  cancel,
+  updateSettings,
+  switchTransport,
+}: LowLevelInjectApi): LowLevelCoreApi =>
+  lowLevelInject({
+    init,
+    call,
+    dispose,
+    eventEmitter,
+    addHardwareGlobalEventListener,
+    uiResponse,
+    cancel,
+    updateSettings,
+    switchTransport,
+  });
+
+const HardwareTopLevelSdk = (): CoreApi => topLevelInject();
+
+export { HardwareTopLevelSdk, HardwareSDKLowLevel };
+
+export default HardwareSdk;