@wix/auto_sdk_identity_authentication 1.0.69 → 1.0.71

package/build/cjs/index.typings.d.ts

@@ -2,6 +2,102 @@ import { NonNullablePaths } from '@wix/sdk-types';
 
 interface Authentication {
 }
+/**
+ * Published for a passed check as well as a rejected one, so a consumer can tell a rejection rate
+ * from a rejection count.
+ *
+ * The caller's IP, geo and user agent are deliberately not fields: they travel as call-scope aspects
+ * in the message headers, which only reach a single-record subscription - a batch handler runs on an
+ * orphan CallScope and loses them.
+ */
+interface CaptchaVerification {
+    /** @format GUID */
+    eventId?: string;
+    /** When the check happened, not when this was published. */
+    eventTime?: Date | null;
+    flow?: CaptchaFlowWithLiterals;
+    identityType?: CaptchaIdentityTypeWithLiterals;
+    /**
+     * Legacy combined outcome. Use result and decision_reason instead.
+     * @deprecated Legacy combined outcome. Use result and decision_reason instead.
+     * @replacedBy result
+     * @targetRemovalDate 2027-04-18
+     */
+    outcome?: CaptchaOutcomeWithLiterals;
+    captchaKind?: CaptchaKindWithLiterals;
+    /**
+     * How far the assessment landed from the minimum it was judged against, positive for a pass. A
+     * margin rather than a raw score because that minimum differs by surface and OS, so raw scores are
+     * not comparable across channels.
+     *
+     * Absent when no score decided the outcome - an inauthentic token, no token at all, or a
+     * PerimeterX escalation where reCAPTCHA itself passed.
+     * @min -1
+     * @max 1
+     */
+    minScoreMargin?: number | null;
+    /**
+     * Google's reasons for the score: AUTOMATION, UNEXPECTED_ENVIRONMENT, TOO_MUCH_TRAFFIC, ...
+     * @maxLength 100
+     * @maxSize 100
+     */
+    reasons?: string[];
+    /** What happened after verification, independently of why. */
+    result?: CaptchaResultWithLiterals;
+    /** The deciding cause of rejection or escalation. Unspecified for a pass. */
+    decisionReason?: CaptchaDecisionReasonWithLiterals;
+}
+declare enum CaptchaFlow {
+    REGISTER = "REGISTER",
+    /** Not published yet. */
+    LOGIN = "LOGIN"
+}
+/** @enumType */
+type CaptchaFlowWithLiterals = CaptchaFlow | 'REGISTER' | 'LOGIN';
+declare enum CaptchaIdentityType {
+    USER = "USER",
+    /** Not published yet. */
+    MEMBER = "MEMBER"
+}
+/** @enumType */
+type CaptchaIdentityTypeWithLiterals = CaptchaIdentityType | 'USER' | 'MEMBER';
+declare enum CaptchaOutcome {
+    PASSED = "PASSED",
+    LOW_SCORE = "LOW_SCORE",
+    /** Rejected as inauthentic, which is independent of the score. */
+    INVALID_TOKEN = "INVALID_TOKEN",
+    MISSING_TOKEN = "MISSING_TOKEN",
+    /**
+     * Escalated to a visible challenge. PerimeterX can cause this while reCAPTCHA itself passed, so it
+     * does not on its own mean the captcha scored badly - `reasons` distinguishes them.
+     */
+    VISIBLE_REQUIRED = "VISIBLE_REQUIRED"
+}
+/** @enumType */
+type CaptchaOutcomeWithLiterals = CaptchaOutcome | 'PASSED' | 'LOW_SCORE' | 'INVALID_TOKEN' | 'MISSING_TOKEN' | 'VISIBLE_REQUIRED';
+declare enum CaptchaKind {
+    INVISIBLE = "INVISIBLE",
+    VISIBLE = "VISIBLE",
+    /** Verified against a site key the client registered itself (branded and headless apps). */
+    CLIENT_SITE_KEY = "CLIENT_SITE_KEY"
+}
+/** @enumType */
+type CaptchaKindWithLiterals = CaptchaKind | 'INVISIBLE' | 'VISIBLE' | 'CLIENT_SITE_KEY';
+declare enum CaptchaResult {
+    VERIFICATION_PASSED = "VERIFICATION_PASSED",
+    VERIFICATION_REJECTED = "VERIFICATION_REJECTED",
+    CHALLENGE_REQUIRED = "CHALLENGE_REQUIRED"
+}
+/** @enumType */
+type CaptchaResultWithLiterals = CaptchaResult | 'VERIFICATION_PASSED' | 'VERIFICATION_REJECTED' | 'CHALLENGE_REQUIRED';
+declare enum CaptchaDecisionReason {
+    SCORE_BELOW_THRESHOLD = "SCORE_BELOW_THRESHOLD",
+    TOKEN_INVALID = "TOKEN_INVALID",
+    TOKEN_MISSING = "TOKEN_MISSING",
+    PERIMETERX_REJECTED = "PERIMETERX_REJECTED"
+}
+/** @enumType */
+type CaptchaDecisionReasonWithLiterals = CaptchaDecisionReason | 'SCORE_BELOW_THRESHOLD' | 'TOKEN_INVALID' | 'TOKEN_MISSING' | 'PERIMETERX_REJECTED';
 interface RegisterV2Request {
     /** Identifier of the registering member. */
     loginId: LoginId;
@@ -1007,6 +1103,97 @@ interface GetWebauthnChallengeResponse {
     /** The challenge that will be used for a WebAuthn authentication ceremony. */
     webauthn?: WebAuthnChallengeData;
 }
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
 /** @docsIgnore */
 type RegisterV2ApplicationErrors = {
     code?: 'UNIMPLEMENTED_FEATURE';
@@ -1287,4 +1474,4 @@ interface LogoutOptions {
     clientId?: string | null;
 }
 
-export { type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticatorConnection, type CallVerifyData, type CaptchaToken, type CaptchaTokenTokenOneOf, type ChangePasswordRequest, type ChangePasswordResponse, type ConnectIdpRequest, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, DeliveryMethod, type DeliveryMethodWithLiterals, type Email, EmailTag, type EmailTagWithLiterals, type EmailValidationFailure, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRedirectRequest, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RecaptchaForClientSiteKey, type RecoveryCodeVerifyData, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, V1Reason, type V1ReasonWithLiterals, type ValidateEmailRequest, type ValidateEmailResponse, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, changePassword, loginV2, logout, registerV2, signOn, validateEmail };
+export { type AccountInfo, type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticatorConnection, type CallVerifyData, CaptchaDecisionReason, type CaptchaDecisionReasonWithLiterals, CaptchaFlow, type CaptchaFlowWithLiterals, CaptchaIdentityType, type CaptchaIdentityTypeWithLiterals, CaptchaKind, type CaptchaKindWithLiterals, CaptchaOutcome, type CaptchaOutcomeWithLiterals, CaptchaResult, type CaptchaResultWithLiterals, type CaptchaToken, type CaptchaTokenTokenOneOf, type CaptchaVerification, type ChangePasswordRequest, type ChangePasswordResponse, type ConnectIdpRequest, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, DeliveryMethod, type DeliveryMethodWithLiterals, type Email, EmailTag, type EmailTagWithLiterals, type EmailValidationFailure, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRedirectRequest, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type MessageEnvelope, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RecaptchaForClientSiteKey, type RecoveryCodeVerifyData, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, V1Reason, type V1ReasonWithLiterals, type ValidateEmailRequest, type ValidateEmailResponse, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, changePassword, loginV2, logout, registerV2, signOn, validateEmail };

package/build/cjs/index.typings.js

@@ -21,6 +21,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_typings_exports = {};
 __export(index_typings_exports, {
   AddressTag: () => AddressTag,
+  CaptchaDecisionReason: () => CaptchaDecisionReason,
+  CaptchaFlow: () => CaptchaFlow,
+  CaptchaIdentityType: () => CaptchaIdentityType,
+  CaptchaKind: () => CaptchaKind,
+  CaptchaOutcome: () => CaptchaOutcome,
+  CaptchaResult: () => CaptchaResult,
   DeliveryMethod: () => DeliveryMethod,
   EmailTag: () => EmailTag,
   FactorStatus: () => FactorStatus,
@@ -34,6 +40,7 @@ __export(index_typings_exports, {
   StatusName: () => StatusName,
   TenantType: () => TenantType,
   V1Reason: () => V1Reason,
+  WebhookIdentityType: () => WebhookIdentityType,
   changePassword: () => changePassword2,
   loginV2: () => loginV22,
   logout: () => logout2,
@@ -382,6 +389,43 @@ var TRANSFORM_PATHS_02 = [{ path: "profile.addresses.address" }];
 var TRANSFORM_PATHS_12 = [
   { path: "identity.identityProfile.addresses.address" }
 ];
+var CaptchaFlow = /* @__PURE__ */ ((CaptchaFlow2) => {
+  CaptchaFlow2["REGISTER"] = "REGISTER";
+  CaptchaFlow2["LOGIN"] = "LOGIN";
+  return CaptchaFlow2;
+})(CaptchaFlow || {});
+var CaptchaIdentityType = /* @__PURE__ */ ((CaptchaIdentityType2) => {
+  CaptchaIdentityType2["USER"] = "USER";
+  CaptchaIdentityType2["MEMBER"] = "MEMBER";
+  return CaptchaIdentityType2;
+})(CaptchaIdentityType || {});
+var CaptchaOutcome = /* @__PURE__ */ ((CaptchaOutcome2) => {
+  CaptchaOutcome2["PASSED"] = "PASSED";
+  CaptchaOutcome2["LOW_SCORE"] = "LOW_SCORE";
+  CaptchaOutcome2["INVALID_TOKEN"] = "INVALID_TOKEN";
+  CaptchaOutcome2["MISSING_TOKEN"] = "MISSING_TOKEN";
+  CaptchaOutcome2["VISIBLE_REQUIRED"] = "VISIBLE_REQUIRED";
+  return CaptchaOutcome2;
+})(CaptchaOutcome || {});
+var CaptchaKind = /* @__PURE__ */ ((CaptchaKind2) => {
+  CaptchaKind2["INVISIBLE"] = "INVISIBLE";
+  CaptchaKind2["VISIBLE"] = "VISIBLE";
+  CaptchaKind2["CLIENT_SITE_KEY"] = "CLIENT_SITE_KEY";
+  return CaptchaKind2;
+})(CaptchaKind || {});
+var CaptchaResult = /* @__PURE__ */ ((CaptchaResult2) => {
+  CaptchaResult2["VERIFICATION_PASSED"] = "VERIFICATION_PASSED";
+  CaptchaResult2["VERIFICATION_REJECTED"] = "VERIFICATION_REJECTED";
+  CaptchaResult2["CHALLENGE_REQUIRED"] = "CHALLENGE_REQUIRED";
+  return CaptchaResult2;
+})(CaptchaResult || {});
+var CaptchaDecisionReason = /* @__PURE__ */ ((CaptchaDecisionReason2) => {
+  CaptchaDecisionReason2["SCORE_BELOW_THRESHOLD"] = "SCORE_BELOW_THRESHOLD";
+  CaptchaDecisionReason2["TOKEN_INVALID"] = "TOKEN_INVALID";
+  CaptchaDecisionReason2["TOKEN_MISSING"] = "TOKEN_MISSING";
+  CaptchaDecisionReason2["PERIMETERX_REJECTED"] = "PERIMETERX_REJECTED";
+  return CaptchaDecisionReason2;
+})(CaptchaDecisionReason || {});
 var PrivacyStatus = /* @__PURE__ */ ((PrivacyStatus2) => {
   PrivacyStatus2["UNDEFINED"] = "UNDEFINED";
   PrivacyStatus2["PUBLIC"] = "PUBLIC";
@@ -492,6 +536,14 @@ var DeliveryMethod = /* @__PURE__ */ ((DeliveryMethod2) => {
   DeliveryMethod2["WHATSAPP"] = "WHATSAPP";
   return DeliveryMethod2;
 })(DeliveryMethod || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
 async function registerV22(loginId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_transform_paths2.transformPaths)(
@@ -715,6 +767,12 @@ async function logout2(options) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AddressTag,
+  CaptchaDecisionReason,
+  CaptchaFlow,
+  CaptchaIdentityType,
+  CaptchaKind,
+  CaptchaOutcome,
+  CaptchaResult,
   DeliveryMethod,
   EmailTag,
   FactorStatus,
@@ -728,6 +786,7 @@ async function logout2(options) {
   StatusName,
   TenantType,
   V1Reason,
+  WebhookIdentityType,
   changePassword,
   loginV2,
   logout,