Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add two more events for EmailOTP #746

Merged
merged 3 commits into from
Jun 6, 2024
Merged

Add two more events for EmailOTP #746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e748841
Add two more events for EmailOTP
Ethella Jun 6, 2024
9a5f0f9
fix import
Ethella Jun 6, 2024
027fd94
fix was used before it was defined
Ethella Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
140 changes: 74 additions & 66 deletions packages/@magic-sdk/types/src/modules/auth-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { WalletEventOnReceived } from './wallet-types';

export interface LoginWithMagicLinkConfiguration {
/**
* The email address of the user attempting to login.
Expand Down Expand Up @@ -74,40 +76,6 @@ export interface LoginWithEmailOTPConfiguration {
};
}

/**
* EventHandlers
*/
export type LoginWithMagicLinkEventHandlers = {
// Event Received
[LoginWithMagicLinkEventOnReceived.EmailSent]: () => void;
[LoginWithMagicLinkEventOnReceived.EmailNotDeliverable]: () => void;

// Event sent
[LoginWithMagicLinkEventEmit.Retry]: () => void;
} & DeviceVerificationEventHandlers;

export type LoginWithEmailOTPEventHandlers = {
// Event Received
[LoginWithEmailOTPEventOnReceived.EmailOTPSent]: () => void;
[LoginWithEmailOTPEventOnReceived.InvalidEmailOtp]: () => void;
[LoginWithEmailOTPEventOnReceived.ExpiredEmailOtp]: () => void;

// Event sent
[LoginWithEmailOTPEventEmit.VerifyEmailOtp]: (otp: string) => void;
[LoginWithEmailOTPEventEmit.Cancel]: () => void;
} & DeviceVerificationEventHandlers;

type DeviceVerificationEventHandlers = {
// Event Received
[DeviceVerificationEventOnReceived.DeviceNeedsApproval]: () => void;
[DeviceVerificationEventOnReceived.DeviceVerificationEmailSent]: () => void;
[DeviceVerificationEventOnReceived.DeviceVerificationLinkExpired]: () => void;
[DeviceVerificationEventOnReceived.DeviceApproved]: () => void;

// Event sent
[DeviceVerificationEventEmit.Retry]: () => void;
};

/**
* Auth Events Enum
*/
Expand Down Expand Up @@ -142,38 +110,6 @@ export enum DeviceVerificationEventOnReceived {
DeviceVerificationEmailSent = 'device-verification-email-sent',
}

/**
* Update Email
*/

type RecencyCheckEventHandlers = {
[RecencyCheckEventOnReceived.PrimaryAuthFactorNeedsVerification]: () => void;
[RecencyCheckEventOnReceived.PrimaryAuthFactorVerified]: () => void;
[RecencyCheckEventOnReceived.InvalidEmailOtp]: () => void;
[RecencyCheckEventOnReceived.EmailNotDeliverable]: () => void;
[RecencyCheckEventOnReceived.EmailExpired]: () => void;
[RecencyCheckEventOnReceived.EmailSent]: () => void;

[RecencyCheckEventEmit.Cancel]: () => void;
[RecencyCheckEventEmit.Retry]: () => void;
[RecencyCheckEventEmit.VerifyEmailOtp]: (otp: string) => void;
};

export type UpdateEmailEventHandlers = {
[UpdateEmailEventOnReceived.NewAuthFactorNeedsVerification]: () => void;
[UpdateEmailEventOnReceived.EmailUpdated]: () => void;
[UpdateEmailEventOnReceived.InvalidEmailOtp]: () => void;
[UpdateEmailEventOnReceived.EmailNotDeliverable]: () => void;
[UpdateEmailEventOnReceived.EmailExpired]: () => void;
[UpdateEmailEventOnReceived.EmailSent]: () => void;
[UpdateEmailEventOnReceived.InvalidEmail]: () => void;
[UpdateEmailEventOnReceived.EmailAlreadyExists]: () => void;

[UpdateEmailEventEmit.Cancel]: () => void;
[UpdateEmailEventEmit.RetryWithNewEmail]: (email?: string) => void;
[UpdateEmailEventEmit.VerifyEmailOtp]: (otp: string) => void;
} & RecencyCheckEventHandlers;

export enum RecencyCheckEventEmit {
Retry = 'Recency/auth-factor-retry',
Cancel = 'Recency/auth-factor-verification-cancel',
Expand Down Expand Up @@ -205,3 +141,75 @@ export enum UpdateEmailEventOnReceived {
InvalidEmail = 'UpdateEmail/new-email-invalid',
EmailAlreadyExists = 'UpdateEmail/new-email-already-exists',
}

export enum AuthEventOnReceived {
IDTokenCreated = 'Auth/id-token-created',
}

/**
* EventHandlers
*/
export type LoginWithMagicLinkEventHandlers = {
// Event Received
[LoginWithMagicLinkEventOnReceived.EmailSent]: () => void;
[LoginWithMagicLinkEventOnReceived.EmailNotDeliverable]: () => void;

// Event sent
[LoginWithMagicLinkEventEmit.Retry]: () => void;
} & DeviceVerificationEventHandlers;

export type LoginWithEmailOTPEventHandlers = {
// Event Received
[LoginWithEmailOTPEventOnReceived.EmailOTPSent]: () => void;
[LoginWithEmailOTPEventOnReceived.InvalidEmailOtp]: () => void;
[LoginWithEmailOTPEventOnReceived.ExpiredEmailOtp]: () => void;
[AuthEventOnReceived.IDTokenCreated]: (idToken: string) => void;
[WalletEventOnReceived.WalletInfoFetched]: () => void;

// Event sent
[LoginWithEmailOTPEventEmit.VerifyEmailOtp]: (otp: string) => void;
[LoginWithEmailOTPEventEmit.Cancel]: () => void;
} & DeviceVerificationEventHandlers;

type DeviceVerificationEventHandlers = {
// Event Received
[DeviceVerificationEventOnReceived.DeviceNeedsApproval]: () => void;
[DeviceVerificationEventOnReceived.DeviceVerificationEmailSent]: () => void;
[DeviceVerificationEventOnReceived.DeviceVerificationLinkExpired]: () => void;
[DeviceVerificationEventOnReceived.DeviceApproved]: () => void;

// Event sent
[DeviceVerificationEventEmit.Retry]: () => void;
};

/**
* Update Email
*/

type RecencyCheckEventHandlers = {
[RecencyCheckEventOnReceived.PrimaryAuthFactorNeedsVerification]: () => void;
[RecencyCheckEventOnReceived.PrimaryAuthFactorVerified]: () => void;
[RecencyCheckEventOnReceived.InvalidEmailOtp]: () => void;
[RecencyCheckEventOnReceived.EmailNotDeliverable]: () => void;
[RecencyCheckEventOnReceived.EmailExpired]: () => void;
[RecencyCheckEventOnReceived.EmailSent]: () => void;

[RecencyCheckEventEmit.Cancel]: () => void;
[RecencyCheckEventEmit.Retry]: () => void;
[RecencyCheckEventEmit.VerifyEmailOtp]: (otp: string) => void;
};

export type UpdateEmailEventHandlers = {
[UpdateEmailEventOnReceived.NewAuthFactorNeedsVerification]: () => void;
[UpdateEmailEventOnReceived.EmailUpdated]: () => void;
[UpdateEmailEventOnReceived.InvalidEmailOtp]: () => void;
[UpdateEmailEventOnReceived.EmailNotDeliverable]: () => void;
[UpdateEmailEventOnReceived.EmailExpired]: () => void;
[UpdateEmailEventOnReceived.EmailSent]: () => void;
[UpdateEmailEventOnReceived.InvalidEmail]: () => void;
[UpdateEmailEventOnReceived.EmailAlreadyExists]: () => void;

[UpdateEmailEventEmit.Cancel]: () => void;
[UpdateEmailEventEmit.RetryWithNewEmail]: (email?: string) => void;
[UpdateEmailEventEmit.VerifyEmailOtp]: (otp: string) => void;
} & RecencyCheckEventHandlers;
4 changes: 4 additions & 0 deletions packages/@magic-sdk/types/src/modules/wallet-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,7 @@ export interface GaslessTransactionRequest {
*/
customData?: any;
}

export enum WalletEventOnReceived {
WalletInfoFetched = 'Wallet/wallet-info-fetched',
}