Merge pull request #105 from JayHelton/issue#104-Export-SimpleWebAuthn-types

Issue #104-Export-SimpleWebAuthn-types

5 files changed, 22 insertions, 8 deletions

diff --git a/packages/server/src/assertion/generateAssertionOptions.ts b/packages/server/src/assertion/generateAssertionOptions.ts
index 19bce91..35bf13e 100644
--- a/packages/server/src/assertion/generateAssertionOptions.ts
+++ b/packages/server/src/assertion/generateAssertionOptions.ts
@@ -8,7 +8,7 @@ import base64url from 'base64url';
 
 import generateChallenge from '../helpers/generateChallenge';
 
-type Options = {
+export type GenerateAssertionOptionsOpts = {
   allowCredentials?: PublicKeyCredentialDescriptor[];
   challenge?: string | Buffer;
   timeout?: number;
@@ -31,7 +31,7 @@ type Options = {
  * @param rpID Valid domain name (after `https://`)
  */
 export default function generateAssertionOptions(
-  options: Options = {},
+  options: GenerateAssertionOptionsOpts = {},
 ): PublicKeyCredentialRequestOptionsJSON {
   const {
     allowCredentials,
diff --git a/packages/server/src/assertion/verifyAssertionResponse.ts b/packages/server/src/assertion/verifyAssertionResponse.ts
index 2c85e6e..7136510 100644
--- a/packages/server/src/assertion/verifyAssertionResponse.ts
+++ b/packages/server/src/assertion/verifyAssertionResponse.ts
@@ -12,7 +12,7 @@ import verifySignature from '../helpers/verifySignature';
 import parseAuthenticatorData from '../helpers/parseAuthenticatorData';
 import isBase64URLString from '../helpers/isBase64URLString';
 
-type Options = {
+export type VerifyAssertionResponseOpts = {
   credential: AssertionCredentialJSON;
   expectedChallenge: string;
   expectedOrigin: string | string[];
@@ -36,7 +36,7 @@ type Options = {
  * `generateAssertionOptions()`. Activates FIDO-specific user presence and verification checks.
  * Omitting this value defaults verification to a WebAuthn-specific user presence requirement.
  */
-export default function verifyAssertionResponse(options: Options): VerifiedAssertion {
+export default function verifyAssertionResponse(options: VerifyAssertionResponseOpts): VerifiedAssertion {
   const {
     credential,
     expectedChallenge,
diff --git a/packages/server/src/attestation/generateAttestationOptions.ts b/packages/server/src/attestation/generateAttestationOptions.ts
index a523cd1..6faf30c 100644
--- a/packages/server/src/attestation/generateAttestationOptions.ts
+++ b/packages/server/src/attestation/generateAttestationOptions.ts
@@ -11,7 +11,7 @@ import base64url from 'base64url';
 
 import generateChallenge from '../helpers/generateChallenge';
 
-type Options = {
+export type GenerateAttestationOptionsOpts = {
   rpName: string;
   rpID: string;
   userID: string;
@@ -94,7 +94,7 @@ const defaultSupportedAlgorithmIDs = supportedCOSEAlgorithmIdentifiers.filter(id
  * attestation by this RP. See https://www.iana.org/assignments/cose/cose.xhtml#algorithms
  */
 export default function generateAttestationOptions(
-  options: Options,
+  options: GenerateAttestationOptionsOpts,
 ): PublicKeyCredentialCreationOptionsJSON {
   const {
     rpName,
diff --git a/packages/server/src/attestation/verifyAttestationResponse.ts b/packages/server/src/attestation/verifyAttestationResponse.ts
index 023c8f2..0dc200f 100644
--- a/packages/server/src/attestation/verifyAttestationResponse.ts
+++ b/packages/server/src/attestation/verifyAttestationResponse.ts
@@ -20,7 +20,7 @@ import verifyTPM from './verifications/tpm/verifyTPM';
 import verifyAndroidKey from './verifications/verifyAndroidKey';
 import verifyApple from './verifications/verifyApple';
 
-type Options = {
+export type VerifyAttestationResponseOpts = {
   credential: AttestationCredentialJSON;
   expectedChallenge: string;
   expectedOrigin: string | string[];
@@ -45,7 +45,7 @@ type Options = {
  * attestation by this RP. See https://www.iana.org/assignments/cose/cose.xhtml#algorithms
  */
 export default async function verifyAttestationResponse(
-  options: Options,
+  options: VerifyAttestationResponseOpts,
 ): Promise<VerifiedAttestation> {
   const {
     credential,
diff --git a/packages/server/src/index.ts b/packages/server/src/index.ts
index b98edab..defed10 100644
--- a/packages/server/src/index.ts
+++ b/packages/server/src/index.ts
@@ -15,3 +15,17 @@ export {
   verifyAssertionResponse,
   MetadataService,
 };
+
+import type { GenerateAttestationOptionsOpts } from './attestation/generateAttestationOptions';
+import type { GenerateAssertionOptionsOpts } from './assertion/generateAssertionOptions';
+import type { VerifiedAttestation, VerifyAttestationResponseOpts } from './attestation/verifyAttestationResponse';
+import type { VerifiedAssertion, VerifyAssertionResponseOpts } from './assertion/verifyAssertionResponse';
+
+export type {
+  GenerateAttestationOptionsOpts,
+  GenerateAssertionOptionsOpts,
+  VerifyAttestationResponseOpts,
+  VerifyAssertionResponseOpts,
+  VerifiedAttestation,
+  VerifiedAssertion,
+}