Merge pull request #1629 from near/fix_importing_issues_of_biometric_ed25519_package

fix: Fix importing issues of `@near-js/biometric-ed25519` package

Author: gagdiez

.changeset/big-apes-cover.md

@@ -0,0 +1,5 @@
+---
+"@near-js/biometric-ed25519": patch
+---
+
+Fix missing type definitions in editors caused by broken `index.d.ts`

.changeset/some-planets-exist.md

@@ -0,0 +1,5 @@
+---
+"@near-js/biometric-ed25519": patch
+---
+
+Fix error on package import by correcting `@hexagon/base64` import

e2e/package.json

@@ -12,6 +12,7 @@
     "license": "ISC",
     "dependencies": {
         "@near-js/accounts": "file:../packages/accounts",
+        "@near-js/biometric-ed25519": "file:../packages/biometric-ed25519",
         "@near-js/crypto": "file:../packages/crypto",
         "@near-js/providers": "file:../packages/providers",
         "@near-js/signers": "file:../packages/signers",

e2e/pnpm-lock.yaml

@@ -0,0 +1,32 @@
+import {
+    createKey,
+    getKeys,
+    isDeviceSupported,
+    isPassKeyAvailable,
+} from "@near-js/biometric-ed25519";
+import { KeyPair } from "@near-js/crypto";
+import { expectTypeOf, test } from "vitest";
+
+test(`exports "createKey" function with correct type`, async () => {
+    type ExpectedFunction = (username: string) => Promise<KeyPair>;
+
+    expectTypeOf(createKey).toEqualTypeOf<ExpectedFunction>();
+});
+
+test(`exports "getKeys" function with correct type`, async () => {
+    type ExpectedFunction = (username: string) => Promise<[KeyPair, KeyPair]>;
+
+    expectTypeOf(getKeys).toEqualTypeOf<ExpectedFunction>();
+});
+
+test(`exports "isDeviceSupported" function with correct type`, async () => {
+    type ExpectedFunction = () => Promise<boolean>;
+
+    expectTypeOf(isDeviceSupported).toEqualTypeOf<ExpectedFunction>();
+});
+
+test(`exports "isPassKeyAvailable" function with correct type`, async () => {
+    type ExpectedFunction = () => Promise<boolean>;
+
+    expectTypeOf(isPassKeyAvailable).toEqualTypeOf<ExpectedFunction>();
+});

e2e/tests/biometric-ed25519.test-d.ts

@@ -0,0 +1,23 @@
+import {
+    createKey,
+    getKeys,
+    isDeviceSupported,
+    isPassKeyAvailable,
+} from "@near-js/biometric-ed25519";
+import { expect, test } from "vitest";
+
+test(`exports "createKey" function`, () => {
+    expect(createKey).toBeDefined();
+});
+
+test(`exports "getKeys" function`, () => {
+    expect(getKeys).toBeDefined();
+});
+
+test(`exports "isDeviceSupported" function`, () => {
+    expect(isDeviceSupported).toBeDefined();
+});
+
+test(`exports "isPassKeyAvailable" function`, () => {
+    expect(isPassKeyAvailable).toBeDefined();
+});

e2e/tests/biometric-ed25519.test.ts

@@ -1,4 +1,4 @@
-import base64 from '@hexagon/base64';
+import { base64 } from '@hexagon/base64';
 import { Fido2Lib } from 'fido2-lib';
 import cbor from 'cbor-js';
 

packages/biometric-ed25519/src/fido2.ts

@@ -1,4 +1,4 @@
-import base64 from '@hexagon/base64';
+import { base64 } from '@hexagon/base64';
 import { ed25519 } from '@noble/curves/ed25519';
 import { sha256 } from '@noble/hashes/sha256';
 import { Buffer } from 'buffer';
@@ -17,7 +17,7 @@ import {
     sanitizeGetKeyResponse
 } from './utils';
 import { Fido2 } from './fido2';
-import { AssertionResponse } from './index.d';
+import type { AssertionResponse } from './type';
 import { KeyPairString } from '@near-js/crypto';
 
 const CHALLENGE_TIMEOUT_MS = 90 * 1000;

packages/biometric-ed25519/src/index.d.ts

@@ -0,0 +1,13 @@
+export type AssertionResponse = {
+    authenticatorAttachment: 'platform' | 'cross-platform';
+    getClientExtensionResults: () => any;
+    id: string;
+    rawId: string;
+    response: {
+        authenticatorData: string;
+        clientDataJSON: string;
+        signature: string;
+        userHandle: string;
+    };
+    type: 'public-key';
+};