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

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.
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _onekeyfe_hd_core from '@onekeyfe/hd-core';
2
- import { UsbDeviceIdentity, LowLevelCoreApi } from '@onekeyfe/hd-core';
2
+ import { UsbDeviceIdentity } 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,7 +9,6 @@ declare const probeUsbDeviceIdentities: ({ commType, }: {
9
9
  declare const messagePromises: {
10
10
  [key: number]: Deferred<any>;
11
11
  };
12
- declare const HardwareSDKLowLevel: LowLevelCoreApi;
13
12
  declare const HardwareCommonConnectSdk: _onekeyfe_hd_core.CoreApi;
14
13
 
15
- export { HardwareSDKLowLevel, HardwareCommonConnectSdk as default, messagePromises, probeUsbDeviceIdentities };
14
+ export { HardwareCommonConnectSdk as default, messagePromises, probeUsbDeviceIdentities };
package/dist/index.js CHANGED
@@ -606,7 +606,6 @@ var getTransport = function (env) { return __awaiter(void 0, void 0, void 0, fun
606
606
  });
607
607
  }); };
608
608
  var _core;
609
- var _plugin;
610
609
  var _settings = HardwareSdk.parseConnectSettings();
611
610
  var usbIdentityProbeTransports = {};
612
611
  var usbIdentityProbes = {};
@@ -642,7 +641,6 @@ var dispose = function () { return __awaiter(void 0, void 0, void 0, function ()
642
641
  case 0:
643
642
  core = _core;
644
643
  _core = undefined;
645
- _plugin = undefined;
646
644
  eventEmitter.removeAllListeners();
647
645
  Object.keys(messagePromises).forEach(function (key) {
648
646
  delete messagePromises[Number(key)];
@@ -749,7 +747,6 @@ var init = function (settings, _, plugin) { return __awaiter(void 0, void 0, voi
749
747
  return [4 /*yield*/, HardwareSdk.initCore(_settings, Transport, plugin)];
750
748
  case 3:
751
749
  _core = _b.sent();
752
- _plugin = plugin;
753
750
  _core === null || _core === void 0 ? void 0 : _core.on(HardwareSdk.CORE_EVENT, handleMessage);
754
751
  HardwareSdk.setLoggerPostMessage(handleMessage);
755
752
  return [2 /*return*/, true];
@@ -804,62 +801,6 @@ var call = function (params) { return __awaiter(void 0, void 0, void 0, function
804
801
  }); };
805
802
  var updateSettings = function () { return Promise.resolve(true); };
806
803
  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
- });
863
804
  var HardwareCommonConnectSdk = HardwareSdk__default["default"]({
864
805
  eventEmitter: eventEmitter,
865
806
  init: init,
@@ -871,7 +812,6 @@ var HardwareCommonConnectSdk = HardwareSdk__default["default"]({
871
812
  switchTransport: switchTransport,
872
813
  });
873
814
 
874
- exports.HardwareSDKLowLevel = HardwareSDKLowLevel;
875
815
  exports["default"] = HardwareCommonConnectSdk;
876
816
  exports.messagePromises = messagePromises;
877
817
  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.2",
3
+ "version": "1.2.10-alpha.3",
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.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"
24
+ "@onekeyfe/hd-core": "1.2.10-alpha.3",
25
+ "@onekeyfe/hd-shared": "1.2.10-alpha.3",
26
+ "@onekeyfe/hd-transport-emulator": "1.2.10-alpha.3",
27
+ "@onekeyfe/hd-transport-http": "1.2.10-alpha.3",
28
+ "@onekeyfe/hd-transport-lowlevel": "1.2.10-alpha.3",
29
+ "@onekeyfe/hd-transport-usb": "1.2.10-alpha.3",
30
+ "@onekeyfe/hd-transport-web-device": "1.2.10-alpha.3"
31
31
  },
32
- "gitHead": "2bcc72a43379abb005405f18f914330f3f2dbfd7"
32
+ "gitHead": "7ea778fa7f33611198758436b09e26df68cbc0e8"
33
33
  }
package/src/index.ts CHANGED
@@ -1,6 +1,5 @@
1
1
  import EventEmitter from 'events';
2
2
  import HardwareSdk, {
3
- HardwareSDKLowLevel as HardwareLowLevelSdk,
4
3
  CORE_EVENT,
5
4
  DEVICE,
6
5
  DEVICE_EVENT,
@@ -20,7 +19,6 @@ import HardwareSdk, {
20
19
  parseConnectSettings,
21
20
  probeUsbDeviceIdentitiesWithTransport,
22
21
  setLoggerPostMessage,
23
- switchTransport as switchCoreTransport,
24
22
  } from '@onekeyfe/hd-core';
25
23
  import { ERRORS, HardwareErrorCode, createDeferred } from '@onekeyfe/hd-shared';
26
24
  import HttpTransport from '@onekeyfe/hd-transport-http';
@@ -59,7 +57,6 @@ const getTransport = async (env: ConnectSettings['env']) => {
59
57
  };
60
58
 
61
59
  let _core: Core | undefined;
62
- let _plugin: LowlevelTransportSharedPlugin | undefined;
63
60
  let _settings = parseConnectSettings();
64
61
 
65
62
  const usbIdentityProbeTransports: Partial<Record<UsbDeviceIdentity['commType'], WebUsbTransport>> =
@@ -99,7 +96,6 @@ export const messagePromises: { [key: number]: Deferred<any> } = {};
99
96
  const dispose = async () => {
100
97
  const core = _core;
101
98
  _core = undefined;
102
- _plugin = undefined;
103
99
  eventEmitter.removeAllListeners();
104
100
  Object.keys(messagePromises).forEach(key => {
105
101
  delete messagePromises[Number(key)];
@@ -195,7 +191,6 @@ const init = async (
195
191
  try {
196
192
  const Transport = await getTransport(_settings.env);
197
193
  _core = await initCore(_settings, Transport, plugin);
198
- _plugin = plugin;
199
194
  _core?.on(CORE_EVENT, handleMessage);
200
195
  setLoggerPostMessage(handleMessage);
201
196
 
@@ -244,54 +239,6 @@ const call = async (params: any) => {
244
239
  const updateSettings = () => Promise.resolve(true);
245
240
  const switchTransport = () => Promise.resolve({ success: true });
246
241
 
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
-
295
242
  const HardwareCommonConnectSdk = HardwareSdk({
296
243
  eventEmitter,
297
244
  init,
@@ -1,103 +0,0 @@
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
- });