@onekeyfe/hd-core 1.2.0-alpha.20 → 1.2.0-alpha.22

package/src/utils/index.ts

@@ -30,7 +30,24 @@ export {
   checkNeedUpdateBootForTouch,
   checkNeedUpdateBootForClassicAndMini,
 } from '../api/firmware/updateBootloader';
-export { getLanguageConfig, getAutoLockOptions, getAutoShutDownOptions } from './deviceSettings';
+export {
+  DEVICE_SETTINGS_SHARED_FIELDS,
+  DEVICE_SETTINGS_V1_ONLY_FIELDS,
+  DEVICE_SETTINGS_V2_ONLY_FIELDS,
+  PROTOCOL_V2_NEVER_TIMEOUT_MS,
+  getAutoLockOptions,
+  getAutoShutDownOptions,
+  getDeviceSettingsCapabilities,
+  getLanguageConfig,
+  normalizeSafetyCheckLevel,
+} from './deviceSettings';
+export type {
+  DeviceSettingsCapabilities,
+  DeviceSettingsDurationOption,
+  DeviceSettingsField,
+  DeviceSettingsProtocol,
+  DeviceSettingsValueOption,
+} from './deviceSettings';
 
 // Helpers utils
 

package/__tests__/RequestQueue.test.ts

@@ -1,140 +0,0 @@
-import RequestQueue from '../src/core/RequestQueue';
-
-import type { BaseMethod } from '../src/api/BaseMethod';
-
-jest.mock('../src/data/config', () => ({
-  getSDKVersion: jest.fn(() => '1.0.0'),
-  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
-}));
-
-function buildMethod(responseID: number, operationId?: string) {
-  return {
-    connectId: 'device-1',
-    executionPriority: 'normal',
-    payload: { operationId },
-    responseID,
-  } as unknown as BaseMethod;
-}
-
-function buildBackgroundMethod(responseID: number, operationId?: string) {
-  return {
-    ...buildMethod(responseID, operationId),
-    executionPriority: 'background',
-  } as unknown as BaseMethod;
-}
-
-describe('RequestQueue operation cancellation', () => {
-  test('aborts only the request matching the operation id', () => {
-    const queue = new RequestQueue();
-    const portfolio = queue.createTask(buildMethod(1, 'portfolio-1'));
-    const userAction = queue.createTask(buildMethod(2, 'user-action'));
-
-    expect(queue.abortOperation('portfolio-1')).toBe(true);
-    expect(portfolio.abortController?.signal.aborted).toBe(true);
-    expect(userAction.abortController?.signal.aborted).toBe(false);
-  });
-
-  test('returns false for an unknown operation id', () => {
-    const queue = new RequestQueue();
-    queue.createTask(buildMethod(1, 'portfolio-1'));
-
-    expect(queue.abortOperation('missing')).toBe(false);
-  });
-
-  test('honors cancellation that arrives before the request is registered', () => {
-    const queue = new RequestQueue();
-
-    expect(queue.abortOperation('portfolio-1')).toBe(false);
-
-    const portfolio = queue.createTask(buildMethod(1, 'portfolio-1'));
-    const userAction = queue.createTask(buildMethod(2, 'user-action'));
-
-    expect(portfolio.abortController?.signal.aborted).toBe(true);
-    expect(userAction.abortController?.signal.aborted).toBe(false);
-  });
-
-  test('expires a cancellation that is never matched', () => {
-    const nowSpy = jest.spyOn(Date, 'now');
-    nowSpy.mockReturnValueOnce(1_000);
-    const queue = new RequestQueue();
-    queue.abortOperation('portfolio-1');
-    nowSpy.mockReturnValue(31_001);
-
-    const portfolio = queue.createTask(buildMethod(1, 'portfolio-1'));
-
-    expect(portfolio.abortController?.signal.aborted).toBe(false);
-    nowSpy.mockRestore();
-  });
-
-  test('rejects a background request while the device has an active user request', async () => {
-    const queue = new RequestQueue();
-    queue.createTask(buildMethod(1, 'user-action'));
-
-    await expect(
-      queue.admitTask(buildBackgroundMethod(2, 'portfolio-1'), {
-        backgroundPreemptTimeoutMs: 100,
-      })
-    ).resolves.toMatchObject({ status: 'busy' });
-    expect(queue.getTask(2)).toBeUndefined();
-  });
-
-  test('aborts and waits for an active background request before admitting a user request', async () => {
-    const queue = new RequestQueue();
-    const portfolio = queue.createTask(buildBackgroundMethod(1, 'portfolio-1'));
-
-    const admission = queue.admitTask(buildMethod(2, 'user-action'), {
-      backgroundPreemptTimeoutMs: 100,
-    });
-    await Promise.resolve();
-
-    expect(portfolio.abortController?.signal.aborted).toBe(true);
-    expect(queue.getTask(2)).toBeUndefined();
-
-    portfolio.settled.resolve();
-    await Promise.resolve();
-    expect(queue.getTask(2)).toBeUndefined();
-
-    queue.releaseTask(1);
-
-    await expect(admission).resolves.toMatchObject({
-      status: 'reserved',
-      task: { id: 2 },
-    });
-  });
-
-  test('uses the background method abort latency when no admission override is provided', async () => {
-    const queue = new RequestQueue();
-    const portfolio = queue.createTask(buildBackgroundMethod(1, 'portfolio-1'));
-    portfolio.method.maxAbortLatencyMs = 12_000;
-    const waitForTasksReleased = jest
-      .spyOn(queue as any, 'waitForTasksReleased')
-      .mockResolvedValue(false);
-
-    await expect(queue.admitTask(buildMethod(2, 'user-action'))).resolves.toMatchObject({
-      status: 'busy',
-    });
-    expect(waitForTasksReleased).toHaveBeenCalledWith([portfolio], 12_000);
-  });
-
-  test('returns busy when an aborted background request does not release in time', async () => {
-    const queue = new RequestQueue();
-    const portfolio = queue.createTask(buildBackgroundMethod(1, 'portfolio-1'));
-
-    await expect(
-      queue.admitTask(buildMethod(2, 'user-action'), {
-        backgroundPreemptTimeoutMs: 1,
-      })
-    ).resolves.toMatchObject({
-      status: 'busy',
-      blockingTask: { id: 1 },
-    });
-    expect(portfolio.abortController?.signal.aborted).toBe(true);
-    expect(queue.getTask(2)).toBeUndefined();
-
-    queue.releaseTask(1);
-    await expect(queue.admitTask(buildMethod(3, 'user-retry'))).resolves.toMatchObject({
-      status: 'reserved',
-      task: { id: 3 },
-    });
-  });
-});

package/__tests__/UploadPortfolio.test.ts

@@ -1,46 +0,0 @@
-import UploadPortfolio from '../src/api/UploadPortfolio';
-
-jest.mock('../src/data/config', () => ({
-  getSDKVersion: jest.fn(() => '1.0.0'),
-  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
-}));
-
-describe('UploadPortfolio timeout', () => {
-  test('applies the command timeout to staging and PortfolioUpdate', async () => {
-    const packageBytes = new Uint8Array([1, 2, 3]);
-    const typedCall = jest
-      .fn()
-      .mockResolvedValueOnce({ message: { processed_byte: 3 } })
-      .mockResolvedValueOnce({ message: {} });
-    const method = new UploadPortfolio({
-      id: 1,
-      payload: {
-        method: 'uploadPortfolio',
-        packageBytes,
-      },
-    });
-    method.device = {
-      commands: { typedCall },
-    } as any;
-    method.postMessage = jest.fn();
-
-    method.init();
-    await method.run();
-
-    expect(method.executionPriority).toBe('background');
-    expect(typedCall).toHaveBeenNthCalledWith(
-      1,
-      'FilesystemFileWrite',
-      'FilesystemFile',
-      expect.any(Object),
-      { timeoutMs: 5_000 }
-    );
-    expect(typedCall).toHaveBeenNthCalledWith(
-      2,
-      'PortfolioUpdate',
-      'Success',
-      {},
-      { timeoutMs: 5_000 }
-    );
-  });
-});

package/dist/api/protocol-v2/DeviceSettingsGet.d.ts

@@ -1,6 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-export default class DeviceSettingsGet extends BaseMethod {
-    init(): void;
-    run(): Promise<import("packages/hd-transport/dist").DeviceSettings>;
-}
-//# sourceMappingURL=DeviceSettingsGet.d.ts.map

package/dist/api/protocol-v2/DeviceSettingsGet.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DeviceSettingsGet.d.ts","sourceRoot":"","sources":["../../../src/api/protocol-v2/DeviceSettingsGet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,UAAU;IACvD,IAAI;IAQE,GAAG;CAKV"}

package/dist/api/protocol-v2/DeviceSettingsPageShow.d.ts

@@ -1,16 +0,0 @@
-import { DeviceSettingsPage } from '@onekeyfe/hd-transport';
-import { BaseMethod } from '../BaseMethod';
-export type SupportedDeviceSettingsPage = DeviceSettingsPage;
-export type DeviceSettingsPageShowParams = {
-    page?: SupportedDeviceSettingsPage | 'DeviceReset' | 'DevicePinChange' | 'DevicePassphrase' | 'DeviceAirgap';
-    fieldName?: string;
-    field_name?: string;
-};
-export default class DeviceSettingsPageShow extends BaseMethod<{
-    page: SupportedDeviceSettingsPage;
-    field_name?: string;
-}> {
-    init(): void;
-    run(): Promise<import("@onekeyfe/hd-transport").Success>;
-}
-//# sourceMappingURL=DeviceSettingsPageShow.d.ts.map

package/dist/api/protocol-v2/DeviceSettingsPageShow.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DeviceSettingsPageShow.d.ts","sourceRoot":"","sources":["../../../src/api/protocol-v2/DeviceSettingsPageShow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI3C,MAAM,MAAM,2BAA2B,GAAG,kBAAkB,CAAC;AAE7D,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,CAAC,EACD,2BAA2B,GAC3B,aAAa,GACb,iBAAiB,GACjB,kBAAkB,GAClB,cAAc,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAmBF,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,UAAU,CAAC;IAC7D,IAAI,EAAE,2BAA2B,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;IACA,IAAI;IAgBE,GAAG;CAaV"}

package/dist/api/protocol-v2/DeviceSettingsSet.d.ts

@@ -1,12 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-import type { DeviceSettings } from '@onekeyfe/hd-transport';
-export type DeviceSettingsSetParams = {
-    settings?: Omit<DeviceSettings, 'passphrase_enable' | 'airgap_mode'>;
-};
-export default class DeviceSettingsSet extends BaseMethod<{
-    settings: Omit<DeviceSettings, 'passphrase_enable' | 'airgap_mode'>;
-}> {
-    init(): void;
-    run(): Promise<import("@onekeyfe/hd-transport").Success>;
-}
-//# sourceMappingURL=DeviceSettingsSet.d.ts.map

package/dist/api/protocol-v2/DeviceSettingsSet.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DeviceSettingsSet.d.ts","sourceRoot":"","sources":["../../../src/api/protocol-v2/DeviceSettingsSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAK3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,mBAAmB,GAAG,aAAa,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,UAAU,CAAC;IACxD,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,mBAAmB,GAAG,aAAa,CAAC,CAAC;CACrE,CAAC;IACA,IAAI;IAwBE,GAAG;CAKV"}

package/src/api/protocol-v2/DeviceSettingsGet.ts

@@ -1,18 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-import { mapDeviceSettingsToState } from '../../device/DeviceStateMapper';
-
-export default class DeviceSettingsGet extends BaseMethod {
-  init() {
-    this.requireProtocolV2 = true;
-    this.unlockPolicy = 'none';
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = undefined;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall('DeviceSettingsGet', 'DeviceSettings', {});
-    this.device.updateState(mapDeviceSettingsToState(res.message), 'apply-settings');
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/DeviceSettingsPageShow.ts

@@ -1,70 +0,0 @@
-import { DeviceSettingsPage } from '@onekeyfe/hd-transport';
-
-import { BaseMethod } from '../BaseMethod';
-import { invalidParameter } from '../helpers/filesystemValidation';
-import { getProtocolV2SettingsBehavior } from '../../protocols/protocol-v2/settingsUnlockPolicy';
-
-export type SupportedDeviceSettingsPage = DeviceSettingsPage;
-
-export type DeviceSettingsPageShowParams = {
-  page?:
-    | SupportedDeviceSettingsPage
-    | 'DeviceReset'
-    | 'DevicePinChange'
-    | 'DevicePassphrase'
-    | 'DeviceAirgap';
-  fieldName?: string;
-  field_name?: string;
-};
-
-const SUPPORTED_PAGES = new Set<number>([
-  DeviceSettingsPage.DeviceReset,
-  DeviceSettingsPage.DevicePinChange,
-  DeviceSettingsPage.DevicePassphrase,
-  DeviceSettingsPage.DeviceAirgap,
-]);
-
-function normalizePage(value: DeviceSettingsPageShowParams['page']): SupportedDeviceSettingsPage {
-  const page = typeof value === 'string' ? DeviceSettingsPage[value] : value;
-  if (page !== undefined && SUPPORTED_PAGES.has(page)) {
-    return page;
-  }
-  throw invalidParameter(
-    'Parameter [page] must be DeviceReset, DevicePinChange, DevicePassphrase, or DeviceAirgap.'
-  );
-}
-
-export default class DeviceSettingsPageShow extends BaseMethod<{
-  page: SupportedDeviceSettingsPage;
-  field_name?: string;
-}> {
-  init() {
-    this.requireProtocolV2 = true;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = {
-      page: normalizePage(this.payload.page),
-      field_name: this.payload.field_name ?? this.payload.fieldName,
-    };
-    const behavior = getProtocolV2SettingsBehavior({
-      kind: 'page',
-      page: this.params.page,
-    });
-    this.unlockPolicy = behavior.unlockPolicy;
-    this.protocolV2UiInteraction = behavior.uiInteraction;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall(
-      'DeviceSettingsPageShow',
-      'Success',
-      this.params
-    );
-    if (this.params.page === DeviceSettingsPage.DevicePassphrase) {
-      await this.device.getDeviceState({ refreshSections: ['status'] });
-    } else if (this.params.page === DeviceSettingsPage.DeviceAirgap) {
-      await this.device.getDeviceState({ refreshSections: ['settings'] });
-    }
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/DeviceSettingsSet.ts

@@ -1,44 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-import { mapDeviceSettingsToState } from '../../device/DeviceStateMapper';
-import { getProtocolV2SettingsBehavior } from '../../protocols/protocol-v2/settingsUnlockPolicy';
-import { invalidParameter } from '../helpers/filesystemValidation';
-
-import type { DeviceSettings } from '@onekeyfe/hd-transport';
-
-export type DeviceSettingsSetParams = {
-  settings?: Omit<DeviceSettings, 'passphrase_enable' | 'airgap_mode'>;
-};
-
-export default class DeviceSettingsSet extends BaseMethod<{
-  settings: Omit<DeviceSettings, 'passphrase_enable' | 'airgap_mode'>;
-}> {
-  init() {
-    const { settings } = this.payload;
-    if (!settings || typeof settings !== 'object' || Array.isArray(settings)) {
-      throw invalidParameter('Parameter [settings] must be an object.');
-    }
-
-    const {
-      passphrase_enable: _passphraseEnable,
-      airgap_mode: _airgapMode,
-      ...supported
-    } = settings as DeviceSettings;
-    if (Object.keys(supported).length === 0) {
-      throw invalidParameter('Parameter [settings] must contain at least one supported setting.');
-    }
-
-    this.requireProtocolV2 = true;
-    const behavior = getProtocolV2SettingsBehavior({ kind: 'direct', settings: supported });
-    this.unlockPolicy = behavior.unlockPolicy;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = { settings: supported };
-    this.protocolV2UiInteraction = behavior.uiInteraction;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall('DeviceSettingsSet', 'Success', this.params);
-    this.device.updateState(mapDeviceSettingsToState(this.params.settings), 'apply-settings');
-    return Promise.resolve(res.message);
-  }
-}