Skip to content

Commit 3ab9b35

Browse files
authored
fix(passport): ID-3991: Expose method argument types (#2716)
1 parent caf8f70 commit 3ab9b35

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

packages/passport/sdk/src/Passport.ts

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ import {
2626
PassportModuleConfiguration,
2727
User,
2828
UserProfile,
29+
ConnectEvmArguments,
30+
LoginArguments,
2931
} from './types';
3032
import { ConfirmationScreen, EmbeddedLoginPrompt } from './confirmation';
3133
import { ZkEvmProvider } from './zkEvm';
@@ -163,9 +165,7 @@ export class Passport {
163165
* @param {boolean} options.announceProvider - Whether to announce the provider via EIP-6963 for wallet discovery (defaults to true)
164166
* @returns {Provider} The EVM provider instance
165167
*/
166-
public connectEvm(options: {
167-
announceProvider: boolean
168-
} = { announceProvider: true }): Promise<Provider> {
168+
public connectEvm(options: ConnectEvmArguments = { announceProvider: true }): Promise<Provider> {
169169
return withMetricsAsync(async () => {
170170
const provider = new ZkEvmProvider({
171171
passportEventEmitter: this.passportEventEmitter,
@@ -203,13 +203,7 @@ export class Passport {
203203
* @throws {Error} If retrieving the cached user session fails (except for "Unknown or invalid refresh token" errors)
204204
* and useCachedSession is true
205205
*/
206-
public async login(options?: {
207-
useCachedSession?: boolean;
208-
anonymousId?: string;
209-
useSilentLogin?: boolean;
210-
useRedirectFlow?: boolean;
211-
directLoginOptions?: DirectLoginOptions;
212-
}): Promise<UserProfile | null> {
206+
public async login(options?: LoginArguments): Promise<UserProfile | null> {
213207
return withMetricsAsync(async () => {
214208
const { useCachedSession = false, useSilentLogin } = options || {};
215209
let user: User | null = null;

packages/passport/sdk/src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ export {
1919
export type {
2020
LinkWalletParams,
2121
LinkedWallet,
22+
ConnectEvmArguments,
23+
LoginArguments,
2224
UserProfile,
2325
PassportOverrides,
2426
PassportModuleConfiguration,

packages/passport/sdk/src/types.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,18 @@ export type LinkedWallet = {
178178
clientName: string;
179179
};
180180

181+
export type ConnectEvmArguments = {
182+
announceProvider: boolean;
183+
};
184+
185+
export type LoginArguments = {
186+
useCachedSession?: boolean;
187+
anonymousId?: string;
188+
useSilentLogin?: boolean;
189+
useRedirectFlow?: boolean;
190+
directLoginOptions?: DirectLoginOptions;
191+
};
192+
181193
export enum MarketingConsentStatus {
182194
OptedIn = 'opted_in',
183195
Unsubscribed = 'unsubscribed',

0 commit comments

Comments
 (0)