Class ZyntopiaOAuthStrategy

Zyntopia-specific OAuth 2.0 authentication strategy. Pre-configured for Zyntopia services with standard endpoints, scopes, and authentication flows. Extends GenericOAuthStrategy with Zyntopia-specific defaults and configurations.

Hierarchy (View Summary)

GenericOAuthStrategy
- ZyntopiaOAuthStrategy

Index

Constructors

constructor

Methods

clearTokenCache getAuthHeaders getConfig getEnvironment getTokenInfo getZyntopiaConfig isDevelopment isProduction refreshToken forDevelopment forProduction forStaging getDefaultScopes getTokenEndpoint validateZyntopiaConfig

Constructors

constructor

new ZyntopiaOAuthStrategy(config: ZyntopiaOAuthConfig): ZyntopiaOAuthStrategy
Creates a new Zyntopia OAuth authentication strategy.
Parameters
- config: ZyntopiaOAuthConfig
  Zyntopia-specific OAuth configuration
Returns ZyntopiaOAuthStrategy
Overrides GenericOAuthStrategy.constructor
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:50

Methods

clearTokenCache

clearTokenCache(): void
Clears the cached token, forcing a new token request on next use.

Returns void
Inherited from GenericOAuthStrategy.clearTokenCache
- Defined in src/auth/GenericOAuthStrategy.ts:283

getAuthHeaders

getAuthHeaders(): Promise<Record<string, string>>
Gets authentication headers, automatically handling token refresh if needed.

Returns Promise<Record<string, string>>
A promise that resolves to the authentication headers.
Inherited from GenericOAuthStrategy.getAuthHeaders
- Defined in src/auth/GenericOAuthStrategy.ts:103

getConfig

getConfig(): Omit<OAuthConfig, "clientSecret">
Gets the configured OAuth endpoints and settings.

Returns Omit<OAuthConfig, "clientSecret">
Configuration information (excluding sensitive data).
Inherited from GenericOAuthStrategy.getConfig
- Defined in src/auth/GenericOAuthStrategy.ts:309

getEnvironment

getEnvironment(): "production" | "staging" | "development"
Gets the current environment this strategy is configured for.

Returns "production" | "staging" | "development"
The environment ('production', 'staging', or 'development').
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:113

getTokenInfo

getTokenInfo(): | null
| { expiresAt: Date; hasRefreshToken: boolean; scope?: string }
Gets information about the current cached token.

Returns null | { expiresAt: Date; hasRefreshToken: boolean; scope?: string }
Token information or null if no token is cached.
Inherited from GenericOAuthStrategy.getTokenInfo
- Defined in src/auth/GenericOAuthStrategy.ts:293

getZyntopiaConfig

getZyntopiaConfig(): Omit<ZyntopiaOAuthConfig, "clientSecret">
Gets the Zyntopia-specific configuration.

Returns Omit<ZyntopiaOAuthConfig, "clientSecret">
Zyntopia configuration (excluding sensitive data).
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:97

isDevelopment

isDevelopment(): boolean
Checks if this strategy is configured for development/testing.

Returns boolean
True if configured for development or staging, false for production.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:129

isProduction

isProduction(): boolean
Checks if this strategy is configured for production environment.

Returns boolean
True if configured for production, false otherwise.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:121

refreshToken

refreshToken(): Promise<Record<string, string>>
Manually refreshes the cached token.

Returns Promise<Record<string, string>>
A promise that resolves to new authentication headers.
Inherited from GenericOAuthStrategy.refreshToken
- Defined in src/auth/GenericOAuthStrategy.ts:273

`Static`forDevelopment

forDevelopment(
    clientId: string,
    clientSecret: string,
    customScopes?: string,
): ZyntopiaOAuthStrategy
Creates a ZyntopiaOAuthStrategy instance pre-configured for development.
Parameters
- clientId: string
  Zyntopia client ID
- clientSecret: string
  Zyntopia client secret
- OptionalcustomScopes: string
  Optional custom scopes (defaults to development scopes)
Returns ZyntopiaOAuthStrategy
Configured ZyntopiaOAuthStrategy for development.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:180

`Static`forProduction

forProduction(
    clientId: string,
    clientSecret: string,
    customScopes?: string,
): ZyntopiaOAuthStrategy
Creates a ZyntopiaOAuthStrategy instance pre-configured for production.
Parameters
- clientId: string
  Zyntopia client ID
- clientSecret: string
  Zyntopia client secret
- OptionalcustomScopes: string
  Optional custom scopes (defaults to production scopes)
Returns ZyntopiaOAuthStrategy
Configured ZyntopiaOAuthStrategy for production.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:140

`Static`forStaging

forStaging(
    clientId: string,
    clientSecret: string,
    customScopes?: string,
): ZyntopiaOAuthStrategy
Creates a ZyntopiaOAuthStrategy instance pre-configured for staging.
Parameters
- clientId: string
  Zyntopia client ID
- clientSecret: string
  Zyntopia client secret
- OptionalcustomScopes: string
  Optional custom scopes (defaults to staging scopes)
Returns ZyntopiaOAuthStrategy
Configured ZyntopiaOAuthStrategy for staging.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:160

`Static`getDefaultScopes

getDefaultScopes(environment: "production" | "staging" | "development"): string
Gets the default scopes for a specific environment.
Parameters
- environment: "production" | "staging" | "development"
  The environment to get scopes for
Returns string
Default scopes for the specified environment.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:198

`Static`getTokenEndpoint

getTokenEndpoint(environment: "production" | "staging" | "development"): string
Gets the token endpoint for a specific environment.
Parameters
- environment: "production" | "staging" | "development"
  The environment to get endpoint for
Returns string
Token endpoint URL for the specified environment.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:207

`Static`validateZyntopiaConfig

validateZyntopiaConfig(config: ZyntopiaOAuthConfig): void
Validates Zyntopia-specific configuration requirements.
Parameters
- config: ZyntopiaOAuthConfig
  Configuration to validate
Returns void
Throws
If configuration is invalid.
- Defined in src/auth/ZyntopiaOAuthStrategy.ts:216

Class ZyntopiaOAuthStrategy

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ZyntopiaOAuthStrategy

Methods

clearTokenCache

Returns void

getAuthHeaders

Returns Promise<Record<string, string>>

getConfig

Returns Omit<OAuthConfig, "clientSecret">

getEnvironment

Returns "production" | "staging" | "development"

getTokenInfo

Returns null | { expiresAt: Date; hasRefreshToken: boolean; scope?: string }

getZyntopiaConfig

Returns Omit<ZyntopiaOAuthConfig, "clientSecret">

isDevelopment

Returns boolean

isProduction

Returns boolean

refreshToken

Returns Promise<Record<string, string>>

StaticforDevelopment

Parameters

Returns ZyntopiaOAuthStrategy

StaticforProduction

Parameters

Returns ZyntopiaOAuthStrategy

StaticforStaging

Parameters

Returns ZyntopiaOAuthStrategy

StaticgetDefaultScopes

Parameters

Returns string

StaticgetTokenEndpoint

Parameters

Returns string

StaticvalidateZyntopiaConfig

Parameters

Returns void

Throws

Settings

On This Page

`Static`forDevelopment

`Static`forProduction

`Static`forStaging

`Static`getDefaultScopes

`Static`getTokenEndpoint

`Static`validateZyntopiaConfig