@imtbl/passport 2.6.0 → 2.6.2-alpha.0

package/dist/types/Passport.d.ts

@@ -6,7 +6,7 @@ import MagicAdapter from './magic/magicAdapter';
 import { PassportImxProviderFactory } from './starkEx';
 import { PassportConfiguration } from './config';
 import { DirectLoginOptions, DeviceTokenResponse, LinkedWallet, LinkWalletParams, PassportEventMap, PassportModuleConfiguration, UserProfile } from './types';
-import { ConfirmationScreen } from './confirmation';
+import { ConfirmationScreen, EmbeddedLoginPrompt } from './confirmation';
 import { Provider } from './zkEvm/types';
 import TypedEventEmitter from './utils/typedEventEmitter';
 import GuardianClient from './guardian';
@@ -15,6 +15,7 @@ export declare const buildPrivateVars: (passportModuleConfiguration: PassportMod
     authManager: AuthManager;
     magicAdapter: MagicAdapter;
     confirmationScreen: ConfirmationScreen;
+    embeddedLoginPrompt: EmbeddedLoginPrompt;
     immutableXClient: IMXClient;
     multiRollupApiClients: MultiRollupApiClients;
     passportEventEmitter: TypedEventEmitter<PassportEventMap>;
@@ -25,6 +26,7 @@ export declare class Passport {
     private readonly authManager;
     private readonly config;
     private readonly confirmationScreen;
+    private readonly embeddedLoginPrompt;
     private readonly immutableXClient;
     private readonly magicAdapter;
     private readonly multiRollupApiClients;
@@ -83,9 +85,10 @@ export declare class Passport {
     /**
      * Initiates a PKCE flow login.
      * @param {DirectLoginOptions} [directLoginOptions] - If provided, directly redirects to the specified login method
+     * @param {string} [imPassportTraceId] - The trace ID for the PKCE flow
      * @returns {string} The authorization URL for the PKCE flow
      */
-    loginWithPKCEFlow(directLoginOptions?: DirectLoginOptions): Promise<string>;
+    loginWithPKCEFlow(directLoginOptions?: DirectLoginOptions, imPassportTraceId?: string): Promise<string>;
     /**
      * Handles the PKCE flow login callback.
      * @param {string} authorizationCode - The authorization code received from the OAuth provider

package/dist/types/authManager.d.ts

@@ -1,15 +1,17 @@
 import { DirectLoginOptions, User, DeviceTokenResponse, UserZkEvm, UserImx } from './types';
 import { PassportConfiguration } from './config';
+import { EmbeddedLoginPrompt } from './confirmation';
 export default class AuthManager {
     private userManager;
     private deviceCredentialsManager;
     private readonly config;
+    private readonly embeddedLoginPrompt;
     private readonly logoutMode;
     /**
      * Promise that is used to prevent multiple concurrent calls to the refresh token endpoint.
      */
     private refreshingPromise;
-    constructor(config: PassportConfiguration);
+    constructor(config: PassportConfiguration, embeddedLoginPrompt: EmbeddedLoginPrompt);
     private static mapOidcUserToDomainModel;
     private static mapDeviceTokenResponseToOidcUser;
     private buildExtraQueryParams;
@@ -26,7 +28,7 @@ export default class AuthManager {
     getUserOrLogin(): Promise<User>;
     private static shouldUseSigninPopupCallback;
     loginCallback(): Promise<undefined | User>;
-    getPKCEAuthorizationUrl(directLoginOptions?: DirectLoginOptions): Promise<string>;
+    getPKCEAuthorizationUrl(directLoginOptions?: DirectLoginOptions, imPassportTraceId?: string): Promise<string>;
     loginWithPKCEFlowCallback(authorizationCode: string, state: string): Promise<User>;
     private getPKCEToken;
     storeTokens(tokenResponse: DeviceTokenResponse): Promise<User>;

package/dist/types/confirmation/embeddedLoginPrompt.d.ts

@@ -0,0 +1,10 @@
+import { EmbeddedLoginPromptResult } from './types';
+import { PassportConfiguration } from '../config';
+export default class EmbeddedLoginPrompt {
+    private config;
+    constructor(config: PassportConfiguration);
+    private getHref;
+    private static appendIFrameStylesIfNeeded;
+    private getEmbeddedLoginIFrame;
+    displayEmbeddedLoginPrompt(): Promise<EmbeddedLoginPromptResult>;
+}

package/dist/types/confirmation/index.d.ts

@@ -1,2 +1,3 @@
 export { default as ConfirmationScreen } from './confirmation';
+export { default as EmbeddedLoginPrompt } from './embeddedLoginPrompt';
 export * from './types';

package/dist/types/confirmation/types.d.ts

@@ -1,7 +1,8 @@
-export declare enum SendMessage {
+import { DirectLoginMethod, MarketingConsentStatus } from '../types';
+export declare enum ConfirmationSendMessage {
     CONFIRMATION_START = "confirmation_start"
 }
-export declare enum ReceiveMessage {
+export declare enum ConfirmationReceiveMessage {
     CONFIRMATION_WINDOW_READY = "confirmation_window_ready",
     TRANSACTION_CONFIRMED = "transaction_confirmed",
     TRANSACTION_ERROR = "transaction_error",
@@ -10,7 +11,23 @@ export declare enum ReceiveMessage {
     MESSAGE_ERROR = "message_error",
     MESSAGE_REJECTED = "message_rejected"
 }
+export declare enum EmbeddedLoginPromptReceiveMessage {
+    LOGIN_METHOD_SELECTED = "login_method_selected",
+    LOGIN_PROMPT_ERROR = "login_prompt_error",
+    LOGIN_PROMPT_CLOSED = "login_prompt_closed"
+}
 export type ConfirmationResult = {
     confirmed: boolean;
 };
-export declare const PASSPORT_EVENT_TYPE = "imx_passport_confirmation";
+export type EmbeddedLoginPromptResult = {
+    marketingConsentStatus: MarketingConsentStatus;
+    imPassportTraceId: string;
+} & ({
+    directLoginMethod: 'email';
+    email: string;
+} | {
+    directLoginMethod: Exclude<DirectLoginMethod, 'email'>;
+    email?: never;
+});
+export declare const PASSPORT_CONFIRMATION_EVENT_TYPE = "imx_passport_confirmation";
+export declare const EMBEDDED_LOGIN_PROMPT_EVENT_TYPE = "im_passport_embedded_login_prompt";

package/dist/types/overlay/{index.d.ts → confirmationOverlay.d.ts}

@@ -1,5 +1,5 @@
 import { PopupOverlayOptions } from '../types';
-export default class Overlay {
+export default class ConfirmationOverlay {
     private disableGenericPopupOverlay;
     private disableBlockedPopupOverlay;
     private overlay;

package/dist/types/overlay/confirmationOverlay.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/overlay/constants.d.ts

@@ -1,4 +1,5 @@
 export declare const PASSPORT_OVERLAY_ID = "passport-overlay";
+export declare const PASSPORT_OVERLAY_CONTENTS_ID = "passport-overlay-contents";
 export declare const PASSPORT_OVERLAY_CLOSE_ID = "passport-overlay-close";
 export declare const PASSPORT_OVERLAY_TRY_AGAIN_ID = "passport-overlay-try-again";
 export declare const CLOSE_BUTTON_SVG = "\n  <svg\n    viewBox=\"0 0 20 20\"\n    fill=\"none\"\n    xmlns=\"http://www.w3.org/2000/svg\"\n    style=\"width: 20px !important;\"\n    >\n      <path\n        d=\"M16.25 5.75833L14.2417 3.75L10 7.99167L5.75833 3.75L3.75 5.75833L7.99167 10L3.75 14.2417L5.75833 16.25L10 12.0083L14.2417 16.25L16.25 14.2417L12.0083 10L16.25 5.75833Z\"\n        fill=\"#F3F3F3\"\n      />\n  </svg>\n";

package/dist/types/overlay/elements.d.ts

@@ -1,3 +1,5 @@
+export declare const getOverlay: (contents: string) => string;
+export declare const getEmbeddedLoginPromptOverlay: () => string;
 type LinkParams = {
     id: string;
     href: string;

package/dist/types/overlay/embeddedLoginPromptOverlay.d.ts

@@ -0,0 +1,7 @@
+export default class EmbeddedLoginPromptOverlay {
+    private static overlay;
+    private static onCloseListener;
+    private static closeButton;
+    static remove(): void;
+    static appendOverlay(embeddedLoginPrompt: HTMLIFrameElement, onCloseListener: () => void): void;
+}

package/dist/types/overlay/embeddedLoginPromptOverlay.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/types.d.ts

@@ -79,6 +79,7 @@ export interface PassportOverrides {
 export interface PopupOverlayOptions {
     disableGenericPopupOverlay?: boolean;
     disableBlockedPopupOverlay?: boolean;
+    disableHeadlessLoginPromptOverlay?: boolean;
 }
 export interface PassportModuleConfiguration extends ModuleConfiguration<PassportOverrides>, OidcConfiguration {
     /**
@@ -157,7 +158,6 @@ export declare enum MarketingConsentStatus {
     Unsubscribed = "unsubscribed"
 }
 export type DirectLoginOptions = {
-    directLoginMethod: DirectLoginMethod;
     marketingConsentStatus?: MarketingConsentStatus;
 } & ({
     directLoginMethod: 'email';

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@imtbl/passport",
   "description": "Passport module for Immutable SDK",
-  "version": "2.6.0",
+  "version": "2.6.2-alpha.0",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
     "@0xsequence/abi": "^2.0.25",
     "@0xsequence/core": "^2.0.25",
-    "@imtbl/config": "2.6.0",
-    "@imtbl/generated-clients": "2.6.0",
-    "@imtbl/metrics": "2.6.0",
-    "@imtbl/toolkit": "2.6.0",
-    "@imtbl/x-client": "2.6.0",
-    "@imtbl/x-provider": "2.6.0",
+    "@imtbl/config": "2.6.2-alpha.0",
+    "@imtbl/generated-clients": "2.6.2-alpha.0",
+    "@imtbl/metrics": "2.6.2-alpha.0",
+    "@imtbl/toolkit": "2.6.2-alpha.0",
+    "@imtbl/x-client": "2.6.2-alpha.0",
+    "@imtbl/x-provider": "2.6.2-alpha.0",
     "@magic-ext/oidc": "12.0.5",
     "@magic-sdk/provider": "^29.0.5",
     "@metamask/detect-provider": "^2.0.0",