client lib domain sync

Author: robotdan

src/FusionAuthClient.ts

@@ -245,10 +245,10 @@ export class FusionAuthClient {
    * Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
    *
    * @param {WebAuthnLoginRequest} request An object containing data necessary for completing the authentication ceremony
-   * @returns {Promise<ClientResponse<WebAuthnCompleteResponse>>}
+   * @returns {Promise<ClientResponse<WebAuthnAssertResponse>>}
    */
-  completeWebAuthnAssertion(request: WebAuthnLoginRequest): Promise<ClientResponse<WebAuthnCompleteResponse>> {
-    return this.startAnonymous<WebAuthnCompleteResponse, Errors>()
+  completeWebAuthnAssertion(request: WebAuthnLoginRequest): Promise<ClientResponse<WebAuthnAssertResponse>> {
+    return this.startAnonymous<WebAuthnAssertResponse, Errors>()
         .withUri('/api/webauthn/assert')
         .withJSONBody(request)
         .withMethod("POST")
@@ -272,11 +272,11 @@ export class FusionAuthClient {
   /**
    * Complete a WebAuthn registration ceremony by validating the client request and saving the new credential
    *
-   * @param {WebAuthnCompleteRequest} request An object containing data necessary for completing the registration ceremony
-   * @returns {Promise<ClientResponse<WebAuthnCompleteResponse>>}
+   * @param {WebAuthnRegisterCompleteRequest} request An object containing data necessary for completing the registration ceremony
+   * @returns {Promise<ClientResponse<WebAuthnRegisterCompleteResponse>>}
    */
-  completeWebAuthnRegistration(request: WebAuthnCompleteRequest): Promise<ClientResponse<WebAuthnCompleteResponse>> {
-    return this.start<WebAuthnCompleteResponse, Errors>()
+  completeWebAuthnRegistration(request: WebAuthnRegisterCompleteRequest): Promise<ClientResponse<WebAuthnRegisterCompleteResponse>> {
+    return this.start<WebAuthnRegisterCompleteResponse, Errors>()
         .withUri('/api/webauthn/register/complete')
         .withJSONBody(request)
         .withMethod("POST")
@@ -1728,10 +1728,10 @@ export class FusionAuthClient {
   /**
    * Import a WebAuthn credential
    *
-   * @param {WebAuthnImportRequest} request An object containing data necessary for importing the credential
+   * @param {WebAuthnCredentialImportRequest} request An object containing data necessary for importing the credential
    * @returns {Promise<ClientResponse<void>>}
    */
-  importWebAuthnCredential(request: WebAuthnImportRequest): Promise<ClientResponse<void>> {
+  importWebAuthnCredential(request: WebAuthnCredentialImportRequest): Promise<ClientResponse<void>> {
     return this.start<void, Errors>()
         .withUri('/api/webauthn/import')
         .withJSONBody(request)
@@ -4382,11 +4382,11 @@ export class FusionAuthClient {
   /**
    * Start a WebAuthn registration ceremony by generating a new challenge for the user
    *
-   * @param {WebAuthnRegisterRequest} request An object containing data necessary for starting the registration ceremony
-   * @returns {Promise<ClientResponse<WebAuthnRegisterResponse>>}
+   * @param {WebAuthnRegisterStartRequest} request An object containing data necessary for starting the registration ceremony
+   * @returns {Promise<ClientResponse<WebAuthnRegisterStartResponse>>}
    */
-  startWebAuthnRegistration(request: WebAuthnRegisterRequest): Promise<ClientResponse<WebAuthnRegisterResponse>> {
-    return this.start<WebAuthnRegisterResponse, Errors>()
+  startWebAuthnRegistration(request: WebAuthnRegisterStartRequest): Promise<ClientResponse<WebAuthnRegisterStartResponse>> {
+    return this.start<WebAuthnRegisterStartResponse, Errors>()
         .withUri('/api/webauthn/register/start')
         .withJSONBody(request)
         .withMethod("POST")
@@ -5526,18 +5526,6 @@ export enum AuthenticatorAttachmentPreference {
   crossPlatform = "crossPlatform"
 }
 
-/**
- * The <i>authenticator's</i> response for the authentication ceremony in its encoded format
- *
- * @author Spencer Witt
- */
-export interface AuthenticatorAuthenticationResponse {
-  authenticatorData?: string;
-  clientDataJSON?: string;
-  signature?: string;
-  userHandle?: string;
-}
-
 /**
  * @author Daniel DeGroff
  */
@@ -5547,16 +5535,6 @@ export interface AuthenticatorConfiguration {
   timeStep?: number;
 }
 
-/**
- * The <i>authenticator's</i> response for the registration ceremony in its encoded format
- *
- * @author Spencer Witt
- */
-export interface AuthenticatorRegistrationResponse {
-  attestationObject?: string;
-  clientDataJSON?: string;
-}
-
 /**
  * Used by the Relying Party to specify their requirements for authenticator attributes. Fields use the deprecated "resident key" terminology to refer
  * to client-side discoverable credentials to maintain backwards compatibility with WebAuthn Level 1.
@@ -8694,19 +8672,6 @@ export enum ProofKeyForCodeExchangePolicy {
   NotRequiredWhenUsingClientAuthentication = "NotRequiredWhenUsingClientAuthentication"
 }
 
-/**
- * Request to authenticate with WebAuthn
- *
- * @author Spencer Witt
- */
-export interface PublicKeyAuthenticationRequest {
-  clientExtensionResults?: WebAuthnExtensionsClientOutputs;
-  id?: string;
-  response?: AuthenticatorAuthenticationResponse;
-  rpId?: string;
-  type?: string;
-}
-
 /**
  * Allows the Relying Party to specify desired attributes of a new credential.
  *
@@ -8793,20 +8758,6 @@ export interface PublicKeyCredentialUserEntity extends PublicKeyCredentialEntity
   id?: string;
 }
 
-/**
- * Request to register a new public key with WebAuthn
- *
- * @author Spencer Witt
- */
-export interface PublicKeyRegistrationRequest {
-  clientExtensionResults?: WebAuthnExtensionsClientOutputs;
-  id?: string;
-  response?: AuthenticatorRegistrationResponse;
-  rpId?: string;
-  transports?: Array<string>;
-  type?: string;
-}
-
 /**
  * JWT Public Key Response Object
  *
@@ -10789,24 +10740,34 @@ export interface VersionResponse {
 }
 
 /**
- * Request to complete the WebAuthn registration ceremony for a new credential
+ * API response for completing WebAuthn assertion
  *
  * @author Spencer Witt
  */
-export interface WebAuthnCompleteRequest {
-  credential?: PublicKeyRegistrationRequest;
-  origin?: string;
-  rpId?: string;
-  userId?: UUID;
+export interface WebAuthnAssertResponse {
+  credential?: WebAuthnCredential;
 }
 
 /**
- * API response for completing WebAuthn credential registration or assertion
+ * The <i>authenticator's</i> response for the authentication ceremony in its encoded format
  *
  * @author Spencer Witt
  */
-export interface WebAuthnCompleteResponse {
-  credential?: WebAuthnCredential;
+export interface WebAuthnAuthenticatorAuthenticationResponse {
+  authenticatorData?: string;
+  clientDataJSON?: string;
+  signature?: string;
+  userHandle?: string;
+}
+
+/**
+ * The <i>authenticator's</i> response for the registration ceremony in its encoded format
+ *
+ * @author Spencer Witt
+ */
+export interface WebAuthnAuthenticatorRegistrationResponse {
+  attestationObject?: string;
+  clientDataJSON?: string;
 }
 
 /**
@@ -10835,6 +10796,16 @@ export interface WebAuthnCredential {
   userId?: UUID;
 }
 
+/**
+ * API request to import an existing WebAuthn credential(s)
+ *
+ * @author Spencer Witt
+ */
+export interface WebAuthnCredentialImportRequest {
+  credentials?: Array<WebAuthnCredential>;
+  validateDbConstraints?: boolean;
+}
+
 /**
  * WebAuthn Credential API response
  *
@@ -10855,33 +10826,71 @@ export interface WebAuthnExtensionsClientOutputs {
 }
 
 /**
- * API request to import an existing WebAuthn credential(s)
+ * Request to complete the WebAuthn registration ceremony
  *
  * @author Spencer Witt
  */
-export interface WebAuthnImportRequest {
-  credentials?: Array<WebAuthnCredential>;
-  validateDbConstraints?: boolean;
+export interface WebAuthnLoginRequest extends BaseLoginRequest {
+  credential?: WebAuthnPublicKeyAuthenticationRequest;
+  origin?: string;
+  rpId?: string;
+  twoFactorTrustId?: string;
 }
 
 /**
- * Request to complete the WebAuthn registration ceremony
+ * Request to authenticate with WebAuthn
  *
  * @author Spencer Witt
  */
-export interface WebAuthnLoginRequest extends BaseLoginRequest {
-  credential?: PublicKeyAuthenticationRequest;
+export interface WebAuthnPublicKeyAuthenticationRequest {
+  clientExtensionResults?: WebAuthnExtensionsClientOutputs;
+  id?: string;
+  response?: WebAuthnAuthenticatorAuthenticationResponse;
+  rpId?: string;
+  type?: string;
+}
+
+/**
+ * Request to register a new public key with WebAuthn
+ *
+ * @author Spencer Witt
+ */
+export interface WebAuthnPublicKeyRegistrationRequest {
+  clientExtensionResults?: WebAuthnExtensionsClientOutputs;
+  id?: string;
+  response?: WebAuthnAuthenticatorRegistrationResponse;
+  rpId?: string;
+  transports?: Array<string>;
+  type?: string;
+}
+
+/**
+ * Request to complete the WebAuthn registration ceremony for a new credential,.
+ *
+ * @author Spencer Witt
+ */
+export interface WebAuthnRegisterCompleteRequest {
+  credential?: WebAuthnPublicKeyRegistrationRequest;
   origin?: string;
   rpId?: string;
-  twoFactorTrustId?: string;
+  userId?: UUID;
+}
+
+/**
+ * API response for completing WebAuthn credential registration or assertion
+ *
+ * @author Spencer Witt
+ */
+export interface WebAuthnRegisterCompleteResponse {
+  credential?: WebAuthnCredential;
 }
 
 /**
  * API request to start a WebAuthn registration ceremony
  *
  * @author Spencer Witt
  */
-export interface WebAuthnRegisterRequest {
+export interface WebAuthnRegisterStartRequest {
   displayName?: string;
   name?: string;
   userAgent?: string;
@@ -10894,7 +10903,7 @@ export interface WebAuthnRegisterRequest {
  *
  * @author Spencer Witt
  */
-export interface WebAuthnRegisterResponse {
+export interface WebAuthnRegisterStartResponse {
   options?: PublicKeyCredentialCreationOptions;
 }