Class OAuthPlugin

OAuth Plugin for ShogunCore Provides authentication with external OAuth providers

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_category? config core description name oauthConnector version

Methods

_loginOrSignUp assertInitialized assertOAuthConnector clearUserCache completeOAuth configure destroy emit generateCredentials getAvailableProviders getCachedUserInfo handleOAuthCallback handleSimpleOAuth initialize initiateOAuth isSupported login off on once removeAllListeners signUp

Constructors

constructor

Properties

Optional_category

_category?: PluginCategory

Categoria del plugin

Privateconfig

config: Partial<OAuthConfig> = {}

Protectedcore

core: null | ShogunCore = null

Riferimento all'istanza di ShogunCore

description

description: string = "Provides OAuth authentication with external providers for ShogunCore"

Descrizione opzionale del plugin

name

name: string = "oauth"

Nome univoco del plugin - deve essere implementato dalle sottoclassi

PrivateoauthConnector

oauthConnector: null | OAuthConnector = null

version

version: string = "1.0.0"

Versione del plugin - deve essere implementata dalle sottoclassi

Methods

Private_loginOrSignUp

  • _loginOrSignUp(username: string, password?: string): Promise<AuthResult>

    Private helper to login or sign up a user

    Parameters

    • username: string
    • Optionalpassword: string

    Returns Promise<AuthResult>

ProtectedassertInitialized

  • assertInitialized(): ShogunCore

    Verifica che il plugin sia stato inizializzato prima di usare il core

    Returns ShogunCore

    L'istanza di ShogunCore non null

    Throws

    Error se il plugin non è stato inizializzato

PrivateassertOAuthConnector

clearUserCache

  • clearUserCache(userId?: string, provider?: OAuthProvider): void

    Clear user info cache

    Parameters

    Returns void

completeOAuth

configure

  • configure(config: Partial<OAuthConfig>): void

    Configure the OAuth plugin with provider settings

    Parameters

    • config: Partial<OAuthConfig>

      Configuration options for OAuth

    Returns void

destroy

  • destroy(): void

    Distrugge il plugin e libera le risorse

    Returns void

emit

  • emit(event: EventType, data?: unknown): boolean

    Emits an event with arguments

    Parameters

    • event: EventType
    • Optionaldata: unknown

    Returns boolean

generateCredentials

getAvailableProviders

getCachedUserInfo

handleOAuthCallback

  • handleOAuthCallback(
        provider: OAuthProvider,
        authCode: string,
        state?: string,
    ): Promise<AuthResult>

    Handle OAuth callback (for frontend integration) This method would be called when the OAuth provider redirects back

    Parameters

    Returns Promise<AuthResult>

handleSimpleOAuth

  • handleSimpleOAuth(
        provider: OAuthProvider,
        authCode: string,
        state?: string,
    ): Promise<AuthResult>

    Alias for handleOAuthCallback for backward compatibility

    Parameters

    Returns Promise<AuthResult>

    Deprecated

    Use handleOAuthCallback instead

initialize

initiateOAuth

isSupported

login

off

  • off(event: EventType, listener: (data: unknown) => void): void

    Removes an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

on

  • on(event: EventType, listener: (data: unknown) => void): void

    Registers an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

once

  • once(event: EventType, listener: (data: unknown) => void): void

    Registers a one-time event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

removeAllListeners

  • removeAllListeners(event?: EventType): void

    Removes all listeners for an event or all events

    Parameters

    • Optionalevent: EventType

    Returns void

signUp

Settings

Member Visibility

On This Page

Constructors
Properties
Methods