@onekeyfe/hd-common-connect-sdk 1.2.10-alpha.1 → 1.2.10-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,103 @@
1
+ import EventEmitter from 'events';
2
+ import {
3
+ CORE_EVENT,
4
+ DEVICE,
5
+ DEVICE_EVENT,
6
+ UI_EVENT,
7
+ UI_REQUEST,
8
+ IFRAME,
9
+ initCore,
10
+ switchTransport,
11
+ } from '@onekeyfe/hd-core';
12
+
13
+ import { HardwareSDKLowLevel } from '../src';
14
+
15
+ jest.mock('../../core/src/data/config', () => ({
16
+ getSDKVersion: jest.fn(() => '1.0.0-test'),
17
+ DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0-test/',
18
+ }));
19
+ jest.mock('@onekeyfe/hd-core', () => ({
20
+ __esModule: true,
21
+ ...jest.requireActual('@onekeyfe/hd-core'),
22
+ initCore: jest.fn(),
23
+ switchTransport: jest.fn(),
24
+ }));
25
+ jest.mock('@onekeyfe/hd-transport-http', () => ({}));
26
+ jest.mock('@onekeyfe/hd-transport-web-device', () => ({ WebUsbTransport: {} }));
27
+ jest.mock('@onekeyfe/hd-transport-lowlevel', () => ({}));
28
+ jest.mock('@onekeyfe/hd-transport-emulator', () => ({}));
29
+
30
+ const core = Object.assign(new EventEmitter(), {
31
+ handleMessage: jest.fn(),
32
+ dispose: jest.fn(() => {
33
+ core.removeAllListeners();
34
+ return Promise.resolve();
35
+ }),
36
+ });
37
+
38
+ beforeEach(() => {
39
+ jest.clearAllMocks();
40
+ initCore.mockResolvedValue(core);
41
+ });
42
+ afterEach(async () => HardwareSDKLowLevel.dispose());
43
+
44
+ test('initializes, calls and switches the local Core without a DOM or iframe', async () => {
45
+ expect(typeof document).toBe('undefined');
46
+ expect(await HardwareSDKLowLevel.init({ env: 'webusb' })).toBe(true);
47
+ expect(initCore).toHaveBeenCalledWith(
48
+ expect.objectContaining({ env: 'webusb' }),
49
+ expect.anything(),
50
+ undefined
51
+ );
52
+ const response = { success: true, payload: { test: true } };
53
+ core.handleMessage.mockResolvedValue(response);
54
+ expect(await HardwareSDKLowLevel.call({ method: 'getFeatures' })).toBe(response);
55
+ expect(core.handleMessage).toHaveBeenCalledWith(
56
+ expect.objectContaining({
57
+ event: IFRAME.CALL,
58
+ type: IFRAME.CALL,
59
+ payload: expect.objectContaining({ method: 'getFeatures' }),
60
+ })
61
+ );
62
+ expect(await HardwareSDKLowLevel.switchTransport('webusb')).toStrictEqual({
63
+ success: true,
64
+ payload: {},
65
+ });
66
+ expect(switchTransport).toHaveBeenCalledWith({
67
+ env: 'webusb',
68
+ Transport: expect.anything(),
69
+ plugin: undefined,
70
+ });
71
+ });
72
+
73
+ test('keeps the Web LowLevel event envelope and cleans listeners on dispose', async () => {
74
+ const listener = jest.fn();
75
+ HardwareSDKLowLevel.addHardwareGlobalEventListener(listener);
76
+ await HardwareSDKLowLevel.init({ env: 'webusb' });
77
+ const payload = { device: { label: 'Synthetic device' } };
78
+ core.emit(CORE_EVENT, { event: DEVICE_EVENT, type: DEVICE.CONNECT, payload });
79
+ expect(listener).toHaveBeenLastCalledWith({
80
+ ...payload,
81
+ event: DEVICE.CONNECT,
82
+ type: DEVICE.CONNECT,
83
+ });
84
+ const message = { event: UI_EVENT, type: UI_REQUEST.REQUEST_BUTTON, payload: {} };
85
+ core.emit(CORE_EVENT, message);
86
+ expect(listener).toHaveBeenLastCalledWith(message);
87
+ await HardwareSDKLowLevel.dispose();
88
+ await HardwareSDKLowLevel.init({ env: 'webusb' });
89
+ listener.mockClear();
90
+ core.emit(CORE_EVENT, message);
91
+ expect(listener).not.toHaveBeenCalled();
92
+ expect(core.listenerCount(CORE_EVENT)).toBe(1);
93
+ });
94
+
95
+ test('uses settings staged before initialization', async () => {
96
+ await HardwareSDKLowLevel.updateSettings({ env: 'webusb' });
97
+ await HardwareSDKLowLevel.init({ debug: false });
98
+ expect(initCore).toHaveBeenCalledWith(
99
+ expect.objectContaining({ env: 'webusb' }),
100
+ expect.anything(),
101
+ undefined
102
+ );
103
+ });
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _onekeyfe_hd_core from '@onekeyfe/hd-core';
2
- import { UsbDeviceIdentity } from '@onekeyfe/hd-core';
2
+ import { UsbDeviceIdentity, LowLevelCoreApi } from '@onekeyfe/hd-core';
3
3
  import { Deferred } from '@onekeyfe/hd-shared';
4
4
 
5
5
  /** Identify WebUSB without disposing the current SDK, changing settings, or opening a wallet. */
@@ -9,6 +9,7 @@ declare const probeUsbDeviceIdentities: ({ commType, }: {
9
9
  declare const messagePromises: {
10
10
  [key: number]: Deferred<any>;
11
11
  };
12
+ declare const HardwareSDKLowLevel: LowLevelCoreApi;
12
13
  declare const HardwareCommonConnectSdk: _onekeyfe_hd_core.CoreApi;
13
14
 
14
- export { HardwareCommonConnectSdk as default, messagePromises, probeUsbDeviceIdentities };
15
+ export { HardwareSDKLowLevel, HardwareCommonConnectSdk as default, messagePromises, probeUsbDeviceIdentities };
package/dist/index.js CHANGED
@@ -606,6 +606,7 @@ var getTransport = function (env) { return __awaiter(void 0, void 0, void 0, fun
606
606
  });
607
607
  }); };
608
608
  var _core;
609
+ var _plugin;
609
610
  var _settings = HardwareSdk.parseConnectSettings();
610
611
  var usbIdentityProbeTransports = {};
611
612
  var usbIdentityProbes = {};
@@ -641,6 +642,7 @@ var dispose = function () { return __awaiter(void 0, void 0, void 0, function ()
641
642
  case 0:
642
643
  core = _core;
643
644
  _core = undefined;
645
+ _plugin = undefined;
644
646
  eventEmitter.removeAllListeners();
645
647
  Object.keys(messagePromises).forEach(function (key) {
646
648
  delete messagePromises[Number(key)];
@@ -747,6 +749,7 @@ var init = function (settings, _, plugin) { return __awaiter(void 0, void 0, voi
747
749
  return [4 /*yield*/, HardwareSdk.initCore(_settings, Transport, plugin)];
748
750
  case 3:
749
751
  _core = _b.sent();
752
+ _plugin = plugin;
750
753
  _core === null || _core === void 0 ? void 0 : _core.on(HardwareSdk.CORE_EVENT, handleMessage);
751
754
  HardwareSdk.setLoggerPostMessage(handleMessage);
752
755
  return [2 /*return*/, true];
@@ -801,6 +804,62 @@ var call = function (params) { return __awaiter(void 0, void 0, void 0, function
801
804
  }); };
802
805
  var updateSettings = function () { return Promise.resolve(true); };
803
806
  var switchTransport = function () { return Promise.resolve({ success: true }); };
807
+ var addHardwareGlobalEventListener = function (listener) {
808
+ [
809
+ HardwareSdk.UI_EVENT,
810
+ HardwareSdk.LOG_EVENT,
811
+ HardwareSdk.FIRMWARE_EVENT,
812
+ HardwareSdk.DEVICE.CONNECT,
813
+ HardwareSdk.DEVICE.DISCONNECT,
814
+ HardwareSdk.DEVICE.FEATURES,
815
+ HardwareSdk.DEVICE.STATE,
816
+ HardwareSdk.DEVICE.SUPPORT_FEATURES,
817
+ HardwareSdk.UI_REQUEST.FIRMWARE_PROGRESS,
818
+ HardwareSdk.UI_REQUEST.FIRMWARE_TIP,
819
+ HardwareSdk.UI_REQUEST.PREVIOUS_ADDRESS_RESULT,
820
+ ].forEach(function (eventName) {
821
+ eventEmitter.on(eventName, function (message) {
822
+ // Match the Web SDK envelope for device events emitted as payloads.
823
+ var envelope = message;
824
+ var emitMessage = message;
825
+ if (!envelope.event && !envelope.type) {
826
+ emitMessage = __assign({}, message);
827
+ Object.assign(emitMessage, { event: eventName, type: eventName });
828
+ }
829
+ listener(emitMessage);
830
+ });
831
+ });
832
+ };
833
+ var HardwareSDKLowLevel = HardwareSdk.HardwareSDKLowLevel({
834
+ eventEmitter: eventEmitter,
835
+ init: function (settings, sdk, plugin) { return init(__assign(__assign({}, _settings), settings), sdk, plugin); },
836
+ call: call,
837
+ cancel: cancel,
838
+ dispose: dispose,
839
+ addHardwareGlobalEventListener: addHardwareGlobalEventListener,
840
+ uiResponse: uiResponse,
841
+ updateSettings: function (settings) {
842
+ if (_core)
843
+ throw hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.IFrameAleradyInitialized);
844
+ _settings = HardwareSdk.parseConnectSettings(__assign(__assign({}, _settings), settings));
845
+ return Promise.resolve(true);
846
+ },
847
+ switchTransport: function (env) { return __awaiter(void 0, void 0, void 0, function () {
848
+ var Transport;
849
+ return __generator(this, function (_a) {
850
+ switch (_a.label) {
851
+ case 0:
852
+ if (!_core)
853
+ throw hdShared.ERRORS.TypedError(hdShared.HardwareErrorCode.NotInitialized);
854
+ return [4 /*yield*/, getTransport(env)];
855
+ case 1:
856
+ Transport = _a.sent();
857
+ HardwareSdk.switchTransport({ env: env, Transport: Transport, plugin: _plugin });
858
+ return [2 /*return*/, { success: true, payload: {} }];
859
+ }
860
+ });
861
+ }); },
862
+ });
804
863
  var HardwareCommonConnectSdk = HardwareSdk__default["default"]({
805
864
  eventEmitter: eventEmitter,
806
865
  init: init,
@@ -812,6 +871,7 @@ var HardwareCommonConnectSdk = HardwareSdk__default["default"]({
812
871
  switchTransport: switchTransport,
813
872
  });
814
873
 
874
+ exports.HardwareSDKLowLevel = HardwareSDKLowLevel;
815
875
  exports["default"] = HardwareCommonConnectSdk;
816
876
  exports.messagePromises = messagePromises;
817
877
  exports.probeUsbDeviceIdentities = probeUsbDeviceIdentities;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onekeyfe/hd-common-connect-sdk",
3
- "version": "1.2.10-alpha.1",
3
+ "version": "1.2.10-alpha.2",
4
4
  "author": "OneKey",
5
5
  "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
6
6
  "license": "ISC",
@@ -21,13 +21,13 @@
21
21
  "lint:fix": "eslint . --fix"
22
22
  },
23
23
  "dependencies": {
24
- "@onekeyfe/hd-core": "1.2.10-alpha.1",
25
- "@onekeyfe/hd-shared": "1.2.10-alpha.1",
26
- "@onekeyfe/hd-transport-emulator": "1.2.10-alpha.1",
27
- "@onekeyfe/hd-transport-http": "1.2.10-alpha.1",
28
- "@onekeyfe/hd-transport-lowlevel": "1.2.10-alpha.1",
29
- "@onekeyfe/hd-transport-usb": "1.2.10-alpha.1",
30
- "@onekeyfe/hd-transport-web-device": "1.2.10-alpha.1"
24
+ "@onekeyfe/hd-core": "1.2.10-alpha.2",
25
+ "@onekeyfe/hd-shared": "1.2.10-alpha.2",
26
+ "@onekeyfe/hd-transport-emulator": "1.2.10-alpha.2",
27
+ "@onekeyfe/hd-transport-http": "1.2.10-alpha.2",
28
+ "@onekeyfe/hd-transport-lowlevel": "1.2.10-alpha.2",
29
+ "@onekeyfe/hd-transport-usb": "1.2.10-alpha.2",
30
+ "@onekeyfe/hd-transport-web-device": "1.2.10-alpha.2"
31
31
  },
32
- "gitHead": "df785eba29f144fac2cfdcbd808426e0a2c259b2"
32
+ "gitHead": "2bcc72a43379abb005405f18f914330f3f2dbfd7"
33
33
  }
package/src/index.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import EventEmitter from 'events';
2
2
  import HardwareSdk, {
3
+ HardwareSDKLowLevel as HardwareLowLevelSdk,
3
4
  CORE_EVENT,
4
5
  DEVICE,
5
6
  DEVICE_EVENT,
@@ -19,6 +20,7 @@ import HardwareSdk, {
19
20
  parseConnectSettings,
20
21
  probeUsbDeviceIdentitiesWithTransport,
21
22
  setLoggerPostMessage,
23
+ switchTransport as switchCoreTransport,
22
24
  } from '@onekeyfe/hd-core';
23
25
  import { ERRORS, HardwareErrorCode, createDeferred } from '@onekeyfe/hd-shared';
24
26
  import HttpTransport from '@onekeyfe/hd-transport-http';
@@ -57,6 +59,7 @@ const getTransport = async (env: ConnectSettings['env']) => {
57
59
  };
58
60
 
59
61
  let _core: Core | undefined;
62
+ let _plugin: LowlevelTransportSharedPlugin | undefined;
60
63
  let _settings = parseConnectSettings();
61
64
 
62
65
  const usbIdentityProbeTransports: Partial<Record<UsbDeviceIdentity['commType'], WebUsbTransport>> =
@@ -96,6 +99,7 @@ export const messagePromises: { [key: number]: Deferred<any> } = {};
96
99
  const dispose = async () => {
97
100
  const core = _core;
98
101
  _core = undefined;
102
+ _plugin = undefined;
99
103
  eventEmitter.removeAllListeners();
100
104
  Object.keys(messagePromises).forEach(key => {
101
105
  delete messagePromises[Number(key)];
@@ -191,6 +195,7 @@ const init = async (
191
195
  try {
192
196
  const Transport = await getTransport(_settings.env);
193
197
  _core = await initCore(_settings, Transport, plugin);
198
+ _plugin = plugin;
194
199
  _core?.on(CORE_EVENT, handleMessage);
195
200
  setLoggerPostMessage(handleMessage);
196
201
 
@@ -239,6 +244,54 @@ const call = async (params: any) => {
239
244
  const updateSettings = () => Promise.resolve(true);
240
245
  const switchTransport = () => Promise.resolve({ success: true });
241
246
 
247
+ const addHardwareGlobalEventListener = (listener: (message: CoreMessage) => void) => {
248
+ [
249
+ UI_EVENT,
250
+ LOG_EVENT,
251
+ FIRMWARE_EVENT,
252
+ DEVICE.CONNECT,
253
+ DEVICE.DISCONNECT,
254
+ DEVICE.FEATURES,
255
+ DEVICE.STATE,
256
+ DEVICE.SUPPORT_FEATURES,
257
+ UI_REQUEST.FIRMWARE_PROGRESS,
258
+ UI_REQUEST.FIRMWARE_TIP,
259
+ UI_REQUEST.PREVIOUS_ADDRESS_RESULT,
260
+ ].forEach(eventName => {
261
+ eventEmitter.on(eventName, (message: CoreMessage) => {
262
+ // Match the Web SDK envelope for device events emitted as payloads.
263
+ const envelope: { event?: string; type?: string } = message;
264
+ let emitMessage = message;
265
+ if (!envelope.event && !envelope.type) {
266
+ emitMessage = { ...message };
267
+ Object.assign(emitMessage, { event: eventName, type: eventName });
268
+ }
269
+ listener(emitMessage);
270
+ });
271
+ });
272
+ };
273
+
274
+ export const HardwareSDKLowLevel = HardwareLowLevelSdk({
275
+ eventEmitter,
276
+ init: (settings, sdk, plugin) => init({ ..._settings, ...settings }, sdk, plugin),
277
+ call,
278
+ cancel,
279
+ dispose,
280
+ addHardwareGlobalEventListener,
281
+ uiResponse,
282
+ updateSettings: (settings: Partial<ConnectSettings>) => {
283
+ if (_core) throw ERRORS.TypedError(HardwareErrorCode.IFrameAleradyInitialized);
284
+ _settings = parseConnectSettings({ ..._settings, ...settings });
285
+ return Promise.resolve(true);
286
+ },
287
+ switchTransport: async (env: ConnectSettings['env']) => {
288
+ if (!_core) throw ERRORS.TypedError(HardwareErrorCode.NotInitialized);
289
+ const Transport = await getTransport(env);
290
+ switchCoreTransport({ env, Transport, plugin: _plugin });
291
+ return { success: true, payload: {} };
292
+ },
293
+ });
294
+
242
295
  const HardwareCommonConnectSdk = HardwareSdk({
243
296
  eventEmitter,
244
297
  init,