@simplewebauthn/types - npm Package Compare versions

Comparing version 10.0.0 to 11.0.0-alpha3

package.json

 {
-  "module": "./esm/index.js",
-  "main": "./script/index.js",
-  "types": "./types/index.d.ts",
   "name": "@simplewebauthn/types",
-  "version": "10.0.0",
+  "version": "11.0.0-alpha3",
   "description": "TypeScript types used by the @simplewebauthn series of libraries",
-  "license": "MIT",
+  "keywords": [
+    "typescript",
+    "webauthn",
+    "passkeys",
+    "fido",
+    "types"
+  ],
   "author": "Matthew Miller <[e-mail]>",
+  "homepage": "https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/types#readme",
   "repository": {
@@ -15,16 +19,9 @@ "type": "git",
   },
-  "homepage": "https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/types#readme",
-  "publishConfig": {
-    "access": "public"
-  },
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/MasterKale/SimpleWebAuthn/issues"
   },
-  "keywords": [
-    "typescript",
-    "webauthn",
-    "passkeys",
-    "fido",
-    "types"
-  ],
+  "main": "./script/index.js",
+  "module": "./esm/index.js",
+  "types": "./types/index.d.ts",
   "exports": {
@@ -41,3 +38,7 @@ ".": {
     }
-  }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "_generatedBy": "dnt@dev"
 }

README.md

@@ -10,3 +10,3 @@ # @simplewebauthn/types <!-- omit in toc -->
   - [Node LTS 20.x or higher](#node-lts-20x-or-higher)
-  - [Deno v1.33.x or higher](#deno-v133x-or-higher)
+  - [Deno v1.43.x or higher](#deno-v143x-or-higher)
 
@@ -17,14 +17,22 @@ ## Installation
 
-This package is available on **npm**:
+This package can be installed from **NPM** or **JSR**:
 
 ```sh
-npm install @simplewebauthn/types
+$ npm install @simplewebauthn/types
 ```
 
-### Deno v1.33.x or higher
+```sh
+$ npx jsr add @simplewebauthn/types
+```
 
-It is also available for import into Deno projects from **deno.land/x**:
+### Deno v1.43.x or higher
 
+It is available for import into Deno projects from **deno.land/x** or **JSR**:
+
 ```ts
 import {...} from 'https://deno.land/x/simplewebauthn/deno/types.ts';
 ```
+
+```sh
+$ deno add jsr:@simplewebauthn/types
+```

types/dom.d.ts

 /**
- * Generated from typescript@5.1.6 typescript/lib/lib.dom.d.ts
- * To regenerate, run the following command from the project root:
- * npx lerna --scope=@simplewebauthn/types exec -- npm run extract-dom-types
+ * Generated from typescript@5.6.3
+ * To regenerate, run the following command from the package root:
+ * deno task extract-dom-types
  */
@@ -27,4 +27,7 @@ /**
     readonly attestationObject: ArrayBuffer;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getAuthenticatorData) */
     getAuthenticatorData(): ArrayBuffer;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getPublicKey) */
     getPublicKey(): ArrayBuffer | null;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getPublicKeyAlgorithm) */
     getPublicKeyAlgorithm(): COSEAlgorithmIdentifier;
@@ -38,2 +41,3 @@ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getTransports) */
     hmacCreateSecret?: boolean;
+    minPinLength?: boolean;
 }
@@ -78,2 +82,3 @@ export interface AuthenticationExtensionsClientOutputs {
 export interface PublicKeyCredential extends Credential {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/PublicKeyCredential/authenticatorAttachment) */
     readonly authenticatorAttachment: string | null;
@@ -151,3 +156,5 @@ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/PublicKeyCredential/rawId) */
     exportKey(format: Exclude<KeyFormat, "jwk">, key: CryptoKey): Promise<ArrayBuffer>;
+    exportKey(format: KeyFormat, key: CryptoKey): Promise<ArrayBuffer | JsonWebKey>;
     /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey) */
+    generateKey(algorithm: "Ed25519", extractable: boolean, keyUsages: ReadonlyArray<"sign" | "verify">): Promise<CryptoKeyPair>;
     generateKey(algorithm: RsaHashedKeyGenParams | EcKeyGenParams, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKeyPair>;
@@ -256,2 +263,6 @@ generateKey(algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
 }
+export interface CryptoKeyPair {
+    privateKey: CryptoKey;
+    publicKey: CryptoKey;
+}
 export interface RsaHashedKeyGenParams extends RsaKeyGenParams {
@@ -263,6 +274,2 @@ hash: HashAlgorithmIdentifier;
 }
-export interface CryptoKeyPair {
-    privateKey: CryptoKey;
-    publicKey: CryptoKey;
-}
 export interface AesKeyGenParams extends Algorithm {
@@ -320,1 +327,2 @@ length: number;
 export type BigInteger = Uint8Array;
+//# sourceMappingURL=dom.d.ts.map

types/index.d.ts

@@ -122,7 +122,7 @@ /**
 /**
- * A WebAuthn-compatible device and the information needed to verify assertions by it
+ * Public key credential information needed to verify authentication responses
  */
-export type AuthenticatorDevice = {
-    credentialID: Base64URLString;
-    credentialPublicKey: Uint8Array;
+export type WebAuthnCredential = {
+    id: Base64URLString;
+    publicKey: Uint8Array;
     counter: number;
@@ -179,1 +179,2 @@ transports?: AuthenticatorTransportFuture[];
 export type CredentialDeviceType = 'singleDevice' | 'multiDevice';
+//# sourceMappingURL=index.d.ts.map

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38979

increased by51.76%

Number of package files

13

increased by18.18%

Lines of code

516

increased by1.38%

Number of lines in readme file

37

increased by27.59%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes