fix: replace BufferSource with Uint8Array in type definitions and function parameters

- Updated type definitions in `types.ts` across multiple files to replace `Uint8Array<ArrayBuffer>` with `Uint8Array` for better clarity and consistency.
- Adjusted function parameters in `base-x.js`, `ec-compression.js`, `utf8.js`, and others to reflect the new type definitions.
- Refactored utility functions to ensure compatibility with the updated types, enhancing maintainability and reducing potential type-related issues.

Author: hugomrdias

packages/iso-base/src/base-x.js

@@ -8,7 +8,7 @@
 
 import _baseX from 'base-x'
 import { utf8 } from './utf8.js'
-import { isBufferSource, u8 } from './utils.js'
+import { isUint8Array, u8 } from './utils.js'
 
 /** @typedef {import('./types.js').Codec} Codec */
 
@@ -35,13 +35,11 @@ export function baseX(base) {
       return _baseX(alphabet).encode(u8(input))
     },
     decode(input) {
-      if (isBufferSource(input)) {
+      if (isUint8Array(input)) {
         input = utf8.encode(input)
       }
 
-      return /** @type {Uint8Array<ArrayBuffer>} */ (
-        _baseX(alphabet).decode(input)
-      )
+      return /** @type {Uint8Array} */ (_baseX(alphabet).decode(input))
     },
   }
 }

packages/iso-base/src/ec-compression.js

@@ -74,7 +74,7 @@ export function isCompressed(key) {
 }
 
 /**
- * @param {Uint8Array<ArrayBuffer>} key
+ * @param {Uint8Array} key
  */
 export function isUncompressed(key) {
   return key[0] === 0x04
@@ -83,7 +83,7 @@ export function isUncompressed(key) {
 /**
  * Elliptic Curve point compression
  *
- * @param { Uint8Array<ArrayBuffer> } pubkeyBytes
+ * @param { Uint8Array } pubkeyBytes
  */
 export function compress(pubkeyBytes) {
   if (!isUncompressed(pubkeyBytes)) {
@@ -105,7 +105,7 @@ export function compress(pubkeyBytes) {
 /**
  * Elliptic Curve point decompression
  *
- * @param {Uint8Array<ArrayBuffer>} comp - Compressed public key. 1st byte: 0x02 for even or 0x03 for odd. Following curve size n bytes: x coordinate expressed as big-endian.
+ * @param {Uint8Array} comp - Compressed public key. 1st byte: 0x02 for even or 0x03 for odd. Following curve size n bytes: x coordinate expressed as big-endian.
  * @param {Curve} curve
  */
 export function decompress(comp, curve = 'P-256') {
@@ -148,7 +148,7 @@ const pIdentSecp256k1 = (primeSecp256k1 + 1n) / 4n
 /**
  * secp256k1 decompression
  *
- * @param {Uint8Array<ArrayBuffer>} compressed
+ * @param {Uint8Array} compressed
  */
 export function decompressSecp256k1(compressed) {
   const signY = BigInt(compressed[0] - 2)

packages/iso-base/src/rfc4648.js

@@ -8,7 +8,7 @@
 /** @typedef {import('./types').Codec} Codec */
 
 import { utf8 } from './utf8.js'
-import { isBufferSource, u8 } from './utils.js'
+import { isUint8Array, u8 } from './utils.js'
 
 /**
  * Decode
@@ -144,7 +144,7 @@ export function rfc4648(base, padding = false, normalize) {
       return encode(u8(input), alphabet, bits, pad ?? padding)
     },
     decode(input) {
-      if (isBufferSource(input)) {
+      if (isUint8Array(input)) {
         input = utf8.encode(input)
       }
 

packages/iso-base/src/types.ts

@@ -18,8 +18,8 @@ export interface Codec {
    * @param data - Data to be encoded to string
    * @param pad - Should have padding. Defaults: true
    */
-  encode: (data: BufferSource | string, pad?: boolean) => string
-  decode: (data: BufferSource | string) => Uint8Array<ArrayBuffer>
+  encode: (data: Uint8Array | string, pad?: boolean) => string
+  decode: (data: Uint8Array | string) => Uint8Array
 }
 
 /**

packages/iso-base/src/utf8.js

@@ -3,7 +3,7 @@
  *
  * @module
  */
-import { isBufferSource, u8 } from './utils.js'
+import { isUint8Array, u8 } from './utils.js'
 
 const textDecoder = new TextDecoder()
 const textEncoder = new TextEncoder()
@@ -19,7 +19,7 @@ export const utf8 = {
     return textDecoder.decode(input)
   },
   decode(input) {
-    if (isBufferSource(input)) {
+    if (isUint8Array(input)) {
       return u8(input)
     }
     return textEncoder.encode(input)

packages/iso-base/src/utils.js

@@ -123,10 +123,21 @@ export function isBufferSource(value) {
   return isTypedArray(value) || isArrayBuffer(value)
 }
 
+/**
+ * @param {unknown} value
+ * @returns {value is Uint8Array}
+ */
+export function isUint8Array(value) {
+  return (
+    value instanceof Uint8Array ||
+    (ArrayBuffer.isView(value) && value.constructor.name === 'Uint8Array')
+  )
+}
+
 /**
  * Cast typedarray to Uint8Array
  *
- * @param {BufferSource} arr
+ * @param {ArrayBuffer | Int8Array | Uint8ClampedArray | Uint8Array | Uint16Array | Int16Array | Uint32Array | Int32Array } arr
  */
 export function u8(arr) {
   return ArrayBuffer.isView(arr)

packages/iso-did/src/key.js

@@ -1,5 +1,4 @@
 import * as EC from 'iso-base/ec-compression'
-import { u8 } from 'iso-base/utils'
 import { tag, varint } from 'iso-base/varint'
 import { base58btc } from 'multiformats/bases/base58'
 import { CODE_KEY_TYPE, KEY_TYPE_CODE } from './common.js'
@@ -15,7 +14,7 @@ const DID_KEY_PREFIX = 'did:key:'
  * Validate raw public key length
  *
  * @param {number} code
- * @param {Uint8Array<ArrayBuffer>} key
+ * @param {Uint8Array} key
  */
 export function validateRawPublicKeyLength(code, key) {
   switch (code) {
@@ -87,7 +86,7 @@ export class DIDKey extends DIDCore {
    *
    * @param {T.DIDURLObject} did
    * @param {T.KeyType} type
-   * @param {Uint8Array<ArrayBuffer>} key
+   * @param {Uint8Array} key
    */
   constructor(did, type, key) {
     super(did)
@@ -124,15 +123,15 @@ export class DIDKey extends DIDCore {
    * Create a DIDKey from a public key bytes
    *
    * @param {T.KeyType} type
-   * @param {Uint8Array<ArrayBuffer>} key
+   * @param {Uint8Array} key
    */
   static fromPublicKey(type, key) {
     const code = KEY_TYPE_CODE[type]
     if (!code) {
       throw new TypeError(`Unsupported key type "${type}"`)
     }
 
-    const keyBytes = validateRawPublicKeyLength(code, u8(key))
+    const keyBytes = validateRawPublicKeyLength(code, key)
     const id = base58btc.encode(tag(code, keyBytes))
 
     return new DIDKey(

packages/iso-did/test/key.test.js

@@ -6,7 +6,7 @@ import { DIDKey } from '../src/key.js'
  * @typedef {import('../src/types').KeyType} PublicKeyType
  */
 
-/** @type {Record<PublicKeyType, {did: string, pub: Uint8Array<ArrayBuffer>}[]>} */
+/** @type {Record<PublicKeyType, {did: string, pub: Uint8Array}[]>} */
 const VECTORS = {
   Ed25519: [
     {

packages/iso-passkeys/src/cose.js

@@ -131,7 +131,7 @@ export function didFromCose(key) {
 /**
  * Hash based on the cose alg using web crypto
  *
- * @param {Uint8Array<ArrayBuffer> | string} data
+ * @param {Uint8Array | string} data
  * @param {import('./cose.js').COSEALG} alg - Cose alg, defaults to -7 (ES256) SHA-256 for web crypto
  */
 export async function hash(data, alg = -7) {
@@ -141,5 +141,7 @@ export async function hash(data, alg = -7) {
 
   const subtleAlg = mapCoseAlgToWebCryptoAlg(alg)
 
-  return new Uint8Array(await webcrypto.subtle.digest(subtleAlg, data))
+  return new Uint8Array(
+    await webcrypto.subtle.digest(subtleAlg, /** @type {BufferSource} */ (data))
+  )
 }

packages/iso-passkeys/src/parsing.js

@@ -126,7 +126,7 @@ export function toPublicKeyCredentialDescriptor(descriptor) {
 
   return {
     ...descriptor,
-    id: base64url.decode(id),
+    id: /** @type {BufferSource} */ (base64url.decode(id)),
   }
 }
 
@@ -145,7 +145,9 @@ export function parseRequestOptionsFromJSON(options) {
     )
   }
   return {
-    challenge: base64url.decode(options.challenge),
+    challenge: /** @type {BufferSource} */ (
+      base64url.decode(options.challenge)
+    ),
     timeout: options.timeout,
     rpId: options.rpId,
     allowCredentials,
@@ -175,10 +177,12 @@ export function parseCreationOptionsFromJSON(options) {
       type: 'public-key',
     })),
     ...options,
-    challenge: base64url.decode(options.challenge),
+    challenge: /** @type {BufferSource} */ (
+      base64url.decode(options.challenge)
+    ),
     user: {
       ...options.user,
-      id: utf8.decode(options.user.id),
+      id: /** @type {BufferSource} */ (utf8.decode(options.user.id)),
     },
 
     excludeCredentials,
@@ -194,7 +198,7 @@ export function parseCreationOptionsFromJSON(options) {
  * @param {import('./types').AuthenticationPublicKeyCredential | import('./types').RegistrationPublicKeyCredential} credential
  */
 export function publicKeyCredentialToJSON(credential) {
-  // @ts-ignore
+  // @ts-expect-error TODO: fix this
   if (credential.response.signature) {
     const { rawId, id, type, authenticatorAttachment, response } =
       /** @type {import('./types').AuthenticationPublicKeyCredential} */ (
@@ -239,7 +243,6 @@ export function publicKeyCredentialToJSON(credential) {
       attestationObject: base64url.encode(
         new Uint8Array(response.attestationObject)
       ),
-      // @ts-ignore
       transports: response.getTransports(),
     },
   }