@wix/auto_sdk_identity_authentication 1.0.18 → 1.0.20

package/build/internal/cjs/meta.d.ts

@@ -363,11 +363,6 @@ interface AuthenticatorConnection {
     reEnrollmentRequired?: boolean;
 }
 interface Metadata {
-    /**
-     * General tags. For example, `"isOwner"`.
-     * @readonly
-     */
-    tags?: string[];
 }
 interface Email {
     /**
@@ -379,22 +374,33 @@ interface Email {
     isVerified?: boolean;
 }
 interface StatusV2 {
+    /** Descriptive name of the identity status. */
     name?: StatusNameWithLiterals;
+    /** Reasons for the current identity status. */
     reasons?: ReasonWithLiterals[];
 }
 declare enum StatusName {
+    /** Unknown status. This value isn't used. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Identity is pending verification, owner approval, or both. */
     PENDING = "PENDING",
+    /** Identity is active and can log in. */
     ACTIVE = "ACTIVE",
+    /** Identity is deleted. This identity can't log in. */
     DELETED = "DELETED",
+    /** Identity is blocked. This identity can't log in. */
     BLOCKED = "BLOCKED",
+    /** Identity is offline. This identity can't log in. */
     OFFLINE = "OFFLINE"
 }
 /** @enumType */
 type StatusNameWithLiterals = StatusName | 'UNKNOWN_STATUS' | 'PENDING' | 'ACTIVE' | 'DELETED' | 'BLOCKED' | 'OFFLINE';
 declare enum Reason {
+    /** Unknown reason. This value isn't used. */
     UNKNOWN_REASON = "UNKNOWN_REASON",
+    /** The identity is waiting for admin approval. After the approval, the identity has an `ACTIVE` status. */
     PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
+    /** The identity has to verify the email. After the verification, the identity has an `ACTIVE` status. */
     PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
 }
 /** @enumType */
@@ -483,6 +489,29 @@ interface LoginV2Request {
     /** Additional data that's relevant for the flow. */
     clientMetaData?: Record<string, any> | null;
 }
+interface WebAuthnVerifyData {
+    /**
+     * The challenge_id from the WebAuthnChallengeData that was returned in the previous
+     * verification response. This will always be present when completing the WebAuthn authentication
+     * ceremony with the credential data from the client.
+     * @format GUID
+     */
+    challengeId?: string | null;
+    /**
+     * If this field is present, this is a request to complete the WebAuthn authentication
+     * with the credential data from the client.
+     *
+     * The credential contains a JSON string representation of a WebAuthn PublicKeyCredential
+     * object returned by the browser during authentication, serialized as per the WebAuthn specification.
+     * The SPI implementation should use this to verify the authentication assertion.
+     *
+     * Any standards-compliant WebAuthn server library should be able to process this serialized format.
+     * For details on the serialization format, refer to the W3C WebAuthn specification:
+     * https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-tojson
+     * @maxLength 3000
+     */
+    credential?: string | null;
+}
 interface ChangePasswordRequest {
     /** The new password to set for the logged in user */
     newPassword: string;
@@ -540,6 +569,7 @@ interface VerifyRequest extends VerifyRequestFactorDataOneOf {
      */
     stateToken?: string;
     factorType: FactorTypeWithLiterals;
+    /** Relevant for second factors only. */
     rememberThisDevice?: boolean;
 }
 /** @oneof */
@@ -583,29 +613,6 @@ interface PushVerifyData {
     /** @maxLength 36 */
     transactionId?: string | null;
 }
-interface WebAuthnVerifyData {
-    /**
-     * The challenge_id from the WebAuthnChallengeData that was returned in the previous
-     * verification response. This will always be present when completing the WebAuthn authentication
-     * ceremony with the credential data from the client.
-     * @format GUID
-     */
-    challengeId?: string | null;
-    /**
-     * If this field is present, this is a request to complete the WebAuthn authentication
-     * with the credential data from the client.
-     *
-     * The credential contains a JSON string representation of a WebAuthn PublicKeyCredential
-     * object returned by the browser during authentication, serialized as per the WebAuthn specification.
-     * The SPI implementation should use this to verify the authentication assertion.
-     *
-     * Any standards-compliant WebAuthn server library should be able to process this serialized format.
-     * For details on the serialization format, refer to the W3C WebAuthn specification:
-     * https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-tojson
-     * @maxLength 3000
-     */
-    credential?: string | null;
-}
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;

package/build/internal/es/index.d.mts

@@ -15,7 +15,7 @@ interface RegisterV2Signature {
      * member need to verify the email address using a code that is sent to the address.
      * @param - Identifier of the registering member.
      */
-    (loginId: LoginId, options?: RegisterV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.metadata.tags` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`> & {
+    (loginId: LoginId, options?: RegisterV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`> & {
         __applicationErrorsType?: RegisterV2ApplicationErrors;
         __validationErrorsType?: RegisterV2ValidationErrors;
     }>;
@@ -30,7 +30,7 @@ interface LoginV2Signature {
      * Use the `sessionToken` in the response to [get the site member's access and refresh tokens](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/handle-members-with-custom-login#get-the-site-members-access-and-refresh-tokens).
      * @param - Identifier of identity logging in.
      */
-    (loginId: LoginId, options?: LoginV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.metadata.tags` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`> & {
+    (loginId: LoginId, options?: LoginV2Options): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`> & {
         __applicationErrorsType?: LoginV2ApplicationErrors;
         __validationErrorsType?: LoginV2ValidationErrors;
     }>;
@@ -46,7 +46,7 @@ interface ChangePasswordSignature {
 declare function signOn$1(httpClient: HttpClient): SignOnSignature;
 interface SignOnSignature {
     /** @param - the identifier of the identity */
-    (loginId: LoginId, options?: SignOnOptions): Promise<NonNullablePaths<SignOnResponse, `sessionToken` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.metadata.tags` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`>>;
+    (loginId: LoginId, options?: SignOnOptions): Promise<NonNullablePaths<SignOnResponse, `sessionToken` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`>>;
 }
 declare function logout$1(httpClient: HttpClient): LogoutSignature;
 interface LogoutSignature {
@@ -58,7 +58,7 @@ interface LogoutSignature {
 declare function verify$1(httpClient: HttpClient): VerifySignature;
 interface VerifySignature {
     /** */
-    (factorType: FactorTypeWithLiterals, options?: VerifyOptions): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.metadata.tags` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`>>;
+    (factorType: FactorTypeWithLiterals, options?: VerifyOptions): Promise<NonNullablePaths<StateMachineResponse, `state` | `identity.connections` | `identity.connections.${number}.idpConnection.idpConnectionId` | `identity.connections.${number}.idpConnection.idpUserId` | `identity.connections.${number}.authenticatorConnection.authenticatorConnectionId` | `identity.connections.${number}.authenticatorConnection.reEnrollmentRequired` | `identity.identityProfile.emails` | `identity.identityProfile.phones` | `identity.identityProfile.labels` | `identity.identityProfile.privacyStatus` | `identity.identityProfile.customFields` | `identity.identityProfile.customFields.${number}.name` | `identity.identityProfile.customFields.${number}.value.strValue` | `identity.identityProfile.customFields.${number}.value.numValue` | `identity.identityProfile.secondaryEmails` | `identity.identityProfile.secondaryEmails.${number}.email` | `identity.identityProfile.secondaryEmails.${number}.tag` | `identity.identityProfile.phonesV2` | `identity.identityProfile.phonesV2.${number}.phone` | `identity.identityProfile.phonesV2.${number}.tag` | `identity.identityProfile.addresses` | `identity.identityProfile.addresses.${number}.tag` | `identity.email.address` | `identity.email.isVerified` | `identity.status.name` | `identity.status.reasons` | `identity.factors` | `identity.factors.${number}.factorId` | `identity.factors.${number}.type` | `identity.factors.${number}.status`>>;
 }
 
 declare const registerV2: MaybeContext<BuildRESTFunction<typeof registerV2$1> & typeof registerV2$1>;

package/build/internal/es/index.mjs

@@ -439,7 +439,6 @@ var TenantType = /* @__PURE__ */ ((TenantType2) => {
   TenantType2["UNKNOWN_TENANT_TYPE"] = "UNKNOWN_TENANT_TYPE";
   TenantType2["ACCOUNT"] = "ACCOUNT";
   TenantType2["SITE"] = "SITE";
-  TenantType2["ROOT"] = "ROOT";
   return TenantType2;
 })(TenantType || {});
 async function registerV22(loginId, options) {