Class SDKAuthProvider

SDK-based authentication provider for VS Code. Manages authentication state and provides event notifications for state changes.

Example

const authProvider = new SDKAuthProvider(sdk, context, logger);
await authProvider.initialize();
authProvider.onAuthStateChanged((state) => {
  // Auth state changed
});

Hierarchy (View Summary)

BaseService
- SDKAuthProvider

Implements

IAuthProvider

Index

Constructors

constructor

new SDKAuthProvider(
    sdk: DatalayerClient,
    context: ExtensionContext,
    logger: ILogger,
): SDKAuthProvider
Parameters
- sdk: DatalayerClient
- context: ExtensionContext
- logger: ILogger
Returns SDKAuthProvider
Overrides BaseService.constructor
- Defined in src/services/core/authProvider.ts:48

Properties

`Private`_authState

_authState: VSCodeAuthState = ...

`Private`_onAuthStateChanged

_onAuthStateChanged: EventEmitter<VSCodeAuthState> = ...

`Private`context

context: ExtensionContext

`Protected` `Readonly`logger

logger: ILogger

Logger instance for this service

`Protected` `Readonly`name

name: string

Service name for logging

`Readonly`onAuthStateChanged

onAuthStateChanged: Event<VSCodeAuthState> = ...

Event fired when authentication state changes.

`Private`sdk

sdk: DatalayerClient

`Private` `Static` `Readonly`TOKEN_SECRET_KEY

TOKEN_SECRET_KEY: "datalayer.token"

Accessors

state

get state(): ServiceState
Gets the current service state.

Returns ServiceState
Inherited from BaseService.state
- Defined in src/services/core/baseService.ts:88

Methods

`Protected`assertReady

assertReady(): void
Asserts that the service is ready for use. Throws an error if the service is not in the Ready state.

Returns void
Throws
Error if service is not ready
Inherited from BaseService.assertReady
- Defined in src/services/core/baseService.ts:148

dispose

dispose(): Promise<void>
Disposes the service and cleans up resources. Ensures disposal only happens once.

Returns Promise<void>
Inherited from BaseService.dispose
- Defined in src/services/core/baseService.ts:123

getAuthState

getAuthState(): VSCodeAuthState
Gets current authentication state.

Returns VSCodeAuthState
Copy of the current authentication state
Implementation of IAuthProvider.getAuthState
- Defined in src/services/core/authProvider.ts:65

getCurrentUser

getCurrentUser(): User
Get current user (null if not authenticated).

Returns User
Implementation of IAuthProvider.getCurrentUser
- Defined in src/services/core/authProvider.ts:388

getToken

getToken(): string
Get authentication token from SDK.

Returns string
Implementation of IAuthProvider.getToken
- Defined in src/services/core/authProvider.ts:395

initialize

initialize(): Promise<void>
Initializes the service. Ensures initialization only happens once and tracks state.

Returns Promise<void>
Implementation of IAuthProvider.initialize
Inherited from BaseService.initialize
- Defined in src/services/core/baseService.ts:96

isAuthenticated

isAuthenticated(): boolean
Check if currently authenticated.

Returns boolean
Implementation of IAuthProvider.isAuthenticated
- Defined in src/services/core/authProvider.ts:381

login(): Promise<void>
Prompts user for token and authenticates with the platform. Updates authentication state based on the result.

Returns Promise<void>
Implementation of IAuthProvider.login
- Defined in src/services/core/authProvider.ts:152

logout

logout(): Promise<void>
Logout and clear authentication state.

Returns Promise<void>
Implementation of IAuthProvider.logout
- Defined in src/services/core/authProvider.ts:225

`Protected`onDispose

onDispose(): Promise<void>
Implementation of BaseService lifecycle disposal. Cleans up event emitters and auth state.

Returns Promise<void>
Overrides BaseService.onDispose
- Defined in src/services/core/authProvider.ts:139

`Protected`onInitialize

onInitialize(): Promise<void>
Implementation of BaseService lifecycle initialization. Verifies existing authentication with the platform.

Returns Promise<void>
Overrides BaseService.onInitialize
- Defined in src/services/core/authProvider.ts:73

`Private`promptForToken

promptForToken(): Promise<string>
Prompt user for their Datalayer access token.

Returns Promise<string>
- Defined in src/services/core/authProvider.ts:360

showAuthStatus

showAuthStatus(): Promise<void>
Shows authentication status with interactive options. Displays different options based on current authentication state. Includes help and feedback links for users.

Returns Promise<void>
Implementation of IAuthProvider.showAuthStatus
- Defined in src/services/core/authProvider.ts:283

Class SDKAuthProvider

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SDKAuthProvider

Properties

Private_authState

Private_onAuthStateChanged

Privatecontext

Protected Readonlylogger

Protected Readonlyname

ReadonlyonAuthStateChanged

Privatesdk

Private Static ReadonlyTOKEN_SECRET_KEY

Accessors

state

Returns ServiceState

Methods

ProtectedassertReady

Returns void

Throws

dispose

Returns Promise<void>

getAuthState

Returns VSCodeAuthState

getCurrentUser

Returns User

getToken

Returns string

initialize

Returns Promise<void>

isAuthenticated

Returns boolean

login

Returns Promise<void>

logout

Returns Promise<void>

ProtectedonDispose

Returns Promise<void>

ProtectedonInitialize

Returns Promise<void>

PrivatepromptForToken

Returns Promise<string>

showAuthStatus

Returns Promise<void>

Settings

On This Page

`Private`_authState

`Private`_onAuthStateChanged

`Private`context

`Protected` `Readonly`logger

`Protected` `Readonly`name

`Readonly`onAuthStateChanged

`Private`sdk

`Private` `Static` `Readonly`TOKEN_SECRET_KEY

`Protected`assertReady

`Protected`onDispose

`Protected`onInitialize

`Private`promptForToken