Class Auth

Global authentication manager handling registration and retrieval of diverse Auth providers (adapters) via an alias registry.

Hierarchy (View Summary)

Core
- Auth

Index

Constructors

constructor

new Auth(): Auth
Returns Auth
Inherited from Core.constructor

Properties

`Protected` `Static`_providers

_providers: AuthRegistry<any> = {}

`Static` `Readonly`classRegistry

classRegistry: { [key: string]: any } = {}

Dictionary holding registered active Quatrain models/components.

`Static`defaultProvider

defaultProvider: string = 'default'

The fallback provider alias.

`Static`ERROR_EMAIL_EXISTS

ERROR_EMAIL_EXISTS: string = ...

Standardized error message for duplicate email constraint violations.

`Static`ERROR_WEAK_PASSWORD

ERROR_WEAK_PASSWORD: string = ...

Standardized error message for weak password / password complexity violations.

`Static`logger

logger: any = ...

Core logger dedicated to Auth actions.

`Static` `Readonly`logLevel

logLevel: DEBUG = LogLevel.DEBUG

System-wide base log verbosity.

`Static` `Readonly`me

me: string = ...

Identifying namespace for this core component.

`Static` `Readonly`storage

storage: typeof NodePersist = persist

Persistent key-value storage engine reference.

`Static` `Readonly`storagePrefix

storagePrefix: "core" = 'core'

Context prefix string for scoped storage keys.

Accessors

`Static`userClass

get userClass(): any
Returns any
Inherited from Core.userClass
- Defined in packages/core/src/Core.ts:181
set userClass(cls: any): void
Parameters
- cls: any
Returns void
Inherited from Core.userClass
- Defined in packages/core/src/Core.ts:185

Methods

`Static`addClass

addClass(name: string, obj: any): void
Maps a specific entity class to an active name so the factory reflection can locate it.
Parameters
- name: string
  Semantic registry name.
- obj: any
  Class constructor.
Returns void
Inherited from Core.addClass
- Defined in packages/core/src/Core.ts:105

`Static`addConfig

addConfig(key: string, value: any): Promise<void>
Stores a primitive value durably in the core storage instance.
Parameters
- key: string
  Identification string.
- value: any
  Value.
Returns Promise<void>
Inherited from Core.addConfig
- Defined in packages/core/src/Core.ts:79

`Static`addLogger

addLogger(alias?: string): any
Injects a new logger block under a specific namespace alias.
Parameters
- alias: string = ...
  The logging context name.
Returns any
Instantiated LoggerAdapter.
Inherited from Core.addLogger
- Defined in packages/core/src/Core.ts:35

`Static`addProvider

addProvider(
    provider: AbstractAuthAdapter,
    alias: string,
    setDefault?: boolean,
): void
Registers a configured auth provider into the global context.
Parameters
- provider: AbstractAuthAdapter
  Instantiated auth adapter.
- alias: string
  Short identifier name.
- setDefault: boolean = false
  If true, marks this adapter as the fallback provider.
Returns void
- Defined in packages/auth/src/Auth.ts:63

`Static`debug

debug(...message: any): void
Triggers a debug log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.debug
- Defined in packages/core/src/Core.ts:203

`Static`definition

definition(
key: string,
): { manifest: { mandatory: boolean; type: StringConstructor } }
Deprecated: Reserved schema definition hook.
Parameters
- key: string
  The property block to generate.
Returns { manifest: { mandatory: boolean; type: StringConstructor } }
Field definitions block.
Inherited from Core.definition
- Defined in packages/core/src/Core.ts:64

`Static`error

error(...message: any): void
Triggers an error log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.error
- Defined in packages/core/src/Core.ts:230

`Static` `Readonly`execPromise

execPromise(command: string, args?: any[], cwd?: string): Promise<any>
Execute an external command in a promise
Parameters
- command: string
- args: any[] = []
- cwd: string = ...
Returns Promise<any>
Promise
See
- https://stackoverflow.com/questions/46289682/how-to-wait-for-child-process-spawn-execution-with-async-await
- https://dzone.com/articles/understanding-execfile-spawn-exec-and-fork-in-node
Inherited from Core.execPromise
- Defined in packages/core/src/Core.ts:127

`Static`getClass

getClass(name: string): any
Returns an injected class constructor by its registry identifier.
Parameters
- name: string
  The semantic name to resolve.
Returns any
Class definition.
Inherited from Core.getClass
- Defined in packages/core/src/Core.ts:115

`Static`getConfig

getConfig(key: string): Promise<any>
Recovers a durably persisted value from the storage layer.
Parameters
- key: string
  The target identifier.
Returns Promise<any>
The recovered value.
Inherited from Core.getConfig
- Defined in packages/core/src/Core.ts:92

`Static`getProvider

getProvider<T extends AbstractAuthAdapter>(alias?: string): T
Fetches a registered provider by its alias.
Type Parameters
- T extends AbstractAuthAdapter
Parameters
- alias: string = ...
  Requested provider identifier. Defaults to defaultProvider.
Returns T
The corresponding auth adapter.

Throws
If the specified alias is unknown.
- Defined in packages/auth/src/Auth.ts:81

`Static` `Readonly`getSystemCommandPath

getSystemCommandPath(command: string): Promise<string>
Utility lookup to find executable paths in the system using which.
Parameters
- command: string
  The executable.
Returns Promise<string>
The resolved system path.
Inherited from Core.getSystemCommandPath
- Defined in packages/core/src/Core.ts:168

`Static`info

info(...message: any): void
Triggers an info log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.info
- Defined in packages/core/src/Core.ts:221

`Static`log

log(...message: any): void
Triggers a standard log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.log
- Defined in packages/core/src/Core.ts:194

`Static`registerEndpoints

registerEndpoints(server: any, rootPath?: string): void
Scans all registered auth providers, collects their endpoint handlers, and registers them dynamically under a common routing root path.
Parameters
- server: any
  The Quatrain ServerAdapter (Astro, Express, etc.).
- rootPath: string = '/api/auth'
  The common authentication root segment (defaults to '/api/auth').
Returns void
- Defined in packages/auth/src/Auth.ts:98

`Static`setLogLevel

setLogLevel(level: LogLevel): void
Mutates the underlying verbosity constraints.
Parameters
- level: LogLevel
  Active LogLevel filter.
Returns void
Inherited from Core.setLogLevel
- Defined in packages/core/src/Core.ts:48

`Static`sleep

sleep(seconds?: number): Promise<unknown>
Execution suspension utility blocking the event loop context.
Parameters
- seconds: number = 1
  Duration count.
Returns Promise<unknown>
The promise to await.
Inherited from Core.sleep
- Defined in packages/core/src/Core.ts:177

`Static` `Readonly`timestamp

timestamp(): string
Returns an ISO string representing the current time.

Returns string
Inherited from Core.timestamp
- Defined in packages/core/src/Core.ts:56

`Static`trace

trace(...message: any): void
Triggers a trace log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.trace
- Defined in packages/core/src/Core.ts:239

`Static`warn

warn(...message: any): void
Triggers a warning log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.warn
- Defined in packages/core/src/Core.ts:212

Class Auth

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Auth

Properties

Protected Static_providers

Static ReadonlyclassRegistry

StaticdefaultProvider

StaticERROR_EMAIL_EXISTS

StaticERROR_WEAK_PASSWORD

Staticlogger

Static ReadonlylogLevel

Static Readonlyme

Static Readonlystorage

Static ReadonlystoragePrefix

Accessors

StaticuserClass

Returns any

Parameters

Returns void

Methods

StaticaddClass

Parameters

Returns void

StaticaddConfig

Parameters

Returns Promise<void>

StaticaddLogger

Parameters

Returns any

StaticaddProvider

Parameters

Returns void

Staticdebug

Parameters

Returns void

Staticdefinition

Parameters

Returns { manifest: { mandatory: boolean; type: StringConstructor } }

Staticerror

Parameters

Returns void

Static ReadonlyexecPromise

Parameters

Returns Promise<any>

See

StaticgetClass

Parameters

Returns any

StaticgetConfig

Parameters

Returns Promise<any>

StaticgetProvider

Type Parameters

Parameters

Returns T

Throws

Static ReadonlygetSystemCommandPath

Parameters

Returns Promise<string>

Staticinfo

Parameters

Returns void

Staticlog

Parameters

Returns void

StaticregisterEndpoints

Parameters

Returns void

StaticsetLogLevel

Parameters

Returns void

Staticsleep

Parameters

`Protected` `Static`_providers

`Static` `Readonly`classRegistry

`Static`defaultProvider

`Static`ERROR_EMAIL_EXISTS

`Static`ERROR_WEAK_PASSWORD

`Static`logger

`Static` `Readonly`logLevel

`Static` `Readonly`me

`Static` `Readonly`storage

`Static` `Readonly`storagePrefix

`Static`userClass

`Static`addClass

`Static`addConfig

`Static`addLogger

`Static`addProvider

`Static`debug

`Static`definition

`Static`error

`Static` `Readonly`execPromise

`Static`getClass

`Static`getConfig

`Static`getProvider

`Static` `Readonly`getSystemCommandPath

`Static`info

`Static`log

`Static`registerEndpoints

`Static`setLogLevel

`Static`sleep

`Static` `Readonly`timestamp

`Static`trace

`Static`warn