Class: Strategy
strategies/Strategy.Strategy
Base class for all strategies.
Param
The name of the strategy
Param
The service to use for strategy instances
Param
The service to use for strategies
Param
Whether the strategy can be used for login and registration of new users (does not affect registering additional accounts)
Param
Whether the strategy can be used to sync with external services
Param
Whether the strategy needs a redirect flow for login
Param
Whether the strategy allows implicit signup
Param
Whether the strategy forces the use of a suggested username
Hierarchy
Strategy
Constructors
constructor
• new Strategy(typeName, strategyInstanceService, strategiesService, canLoginRegister?, canSync?, needsRedirectFlow?, allowsImplicitSignup?, forceSuggestedUsername?)
Parameters
| Name | Type | Default value |
|---|---|---|
typeName | string | undefined |
strategyInstanceService | StrategyInstanceService | undefined |
strategiesService | StrategiesService | undefined |
canLoginRegister | boolean | true |
canSync | boolean | false |
needsRedirectFlow | boolean | false |
allowsImplicitSignup | boolean | false |
forceSuggestedUsername | boolean | false |
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:43
Properties
allowsImplicitSignup
• Readonly allowsImplicitSignup: boolean = false
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:50
canLoginRegister
• Readonly canLoginRegister: boolean = true
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:47
canSync
• Readonly canSync: boolean = false
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:48
forceSuggestedUsername
• Readonly forceSuggestedUsername: boolean = false
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:51
needsRedirectFlow
• Readonly needsRedirectFlow: boolean = false
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:49
strategiesService
• Protected Readonly strategiesService: StrategiesService
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:46
strategyInstanceService
• Protected Readonly strategyInstanceService: StrategyInstanceService
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:45
typeName
• Readonly typeName: string
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:44
Accessors
acceptsVariables
• get acceptsVariables(): StrategyVariable[]
Returns
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:155
instanceConfigSchema
• get instanceConfigSchema(): Record<string, Schema>
Returns
Record<string, Schema>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:163
updateActions
• get updateActions(): StrategyUpdateAction[]
Returns
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:159
Methods
checkAndExtendInstanceConfig
▸ Protected checkAndExtendInstanceConfig(instanceConfig): object
Checks the given config for a instance and extends it (e.g. with default values) of this strategy for validity
For strategies that can sync, this checks the existance and format of
imsTemplatedFieldsFilter in the instance config.
This is expected to contain the fields with the values that are expected
for an IMS to be considered an ims fot this strategy instance.
Parameters
| Name | Type | Description |
|---|---|---|
instanceConfig | object | The config object to check for validity |
Returns
object
The instance config in the way as it should be insterted in the instance
Throws
Any error/exception if the instance config was invalid and no instance may be crated
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:69
createOrUpdateNewInstance
▸ createOrUpdateNewInstance(input, instanceToUpdate?): Promise<StrategyInstance>
Parameters
| Name | Type |
|---|---|
input | UpdateStrategyInstanceInput | CreateStrategyInstanceInput |
instanceToUpdate? | StrategyInstance |
Returns
Promise<StrategyInstance>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:100
existsInstanceClearName
▸ existsInstanceClearName(name): Promise<boolean>
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Promise<boolean>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:140
getAllInstances
▸ getAllInstances(): Promise<StrategyInstance[]>
Returns
Promise<StrategyInstance[]>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:144
getCensoredInstanceConfig
▸ getCensoredInstanceConfig(instance): object
Returns the instance config of the strategy instance, but with sensitive data censored.
WARNING: The result of this function WILL be exposed to the user.
Parameters
| Name | Type | Description |
|---|---|---|
instance | StrategyInstance | The strategy instance for which to get the censored instance config |
Returns
object
The censored instance config
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:286
getImsTemplatedValuesForStrategyInstance
▸ getImsTemplatedValuesForStrategyInstance(instance): object | Promise<object>
Returns the object containing the templated fields and their values that an IMS needs to match, in order to be considered tha IMS that is represented by the strategy instance given. Values will be compared field by field with the templated values of the IMS.
The fields id, name and description of the returned object will not be compared to the templated values,
but instead to the actual fields of the IMS with those respective names.
For example: The API-Url must match in order for a GitHub IMS belonging to a GitHub strategy instance
Can/Should be overridden by strategies capable of sync.
Default implementation returns imsTemplatedFieldsFilter of instance config
Parameters
| Name | Type | Description |
|---|---|---|
instance | StrategyInstance | The strategy instance for which the templated values should be retuned |
Returns
object | Promise<object>
An object which, if it matches the templated fields of an IMS, the given instance is the matching strategy instance for that IMS Null if the strategy does not sync
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:191
getImsUserTemplatedValuesForLoginData
▸ getImsUserTemplatedValuesForLoginData(loginData): object | Promise<object>
Returns the object containing the templated fields and their values that an IMSUser needs to match,
in order to be considered an IMSUser that belongs to the given loginData
(i.e. the IMS is a login of the user of this login data on the ims of this login data)
The fields id, username, displayName and email of the returned object
will not be compared to the templated values,
but instead to the actual fields of the IMSUser with those respective names.
For example: The username on GitHub must match the username in the login data.
Can/Should/Must be overridden by strategies capable of sync.
Default implementation returns the loginData.data field unchanged
Parameters
| Name | Type | Description |
|---|---|---|
loginData | UserLoginData | The login data for which the templated field values should be returned, representing a login of the user using a strategy instance |
Returns
object | Promise<object>
An object which, if it matches the templated fields of an IMSUser, the given loginData is the matching login for that IMSUser Null if the strategy does not sync
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:218
getInstanceById
▸ getInstanceById(id): Promise<StrategyInstance>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<StrategyInstance>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:148
getLoginDataDataForImsUserTemplatedFields
▸ getLoginDataDataForImsUserTemplatedFields(imsUserTemplatedFields): object | Promise<object>
Does the opposite of getImsUserTemplatedValuesForLoginData.
Returns an object that needs to match the data field of a LoginData
in order for the IMSUser to be considerd matching the login data.
The imsUserTemplatedFields should also contain the fields
id, username, displayName and email directly of the IMSUser
in addition to the templated fields and values.
For example: Given templated fields of an IMSUser containing its username, this should return the login data object that also matches the user with that username
Can/Should/Must be overridden by strategies capable of sync.
Default implementation returns the imsUserTemplatedFields unchanged
Parameters
| Name | Type | Description |
|---|---|---|
imsUserTemplatedFields | object | Templated fields and values as well as the fields id, username, displayName and email of the IMSUser. |
Returns
object | Promise<object>
An object, that the .data field of a login data needs to match.
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:257
getLoginDataDescription
▸ getLoginDataDescription(loginData): Promise<string>
Gets a description of the login data, e.g. a username or email.
Parameters
| Name | Type | Description |
|---|---|---|
loginData | UserLoginData | The login data for which to get the description |
Returns
Promise<string>
A description of the login data
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:231
getSyncDataForLoginData
▸ getSyncDataForLoginData(loginData): { [key: string]: any; token: string } | Promise<{ [key: string]: any; token: string }>
Parameters
| Name | Type |
|---|---|
loginData | UserLoginData |
Returns
{ [key: string]: any; token: string } | Promise<{ [key: string]: any; token: string }>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:167
getUserDataSuggestion
▸ getUserDataSuggestion(loginData): Object
For a given login data return data that has been retrieved from the authentication source with which to prefill the input fields for the user registration
WARNING: Does not check wether the returned data is valid or e.g. a username is unique. This is purely a data mapper.
Parameters
| Name | Type | Description |
|---|---|---|
loginData | UserLoginData | The login data of the authentication for which to retrieve the data |
Returns
Object
Suggestions for the user data based on the login data. NOT checked!
| Name | Type |
|---|---|
displayName? | string |
email? | string |
username? | string |
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:274
handleAction
▸ handleAction(loginData, name, data): Promise<void>
Handles an action that was triggered by the user. Actions are defined via updateActions.
Parameters
| Name | Type | Description |
|---|---|---|
loginData | UserLoginData | the login data of the user that triggered the action |
name | string | the name of the action |
data | Record<string, any> | the data for the action |
Returns
Promise<void>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:298
performAuth
▸ Abstract performAuth(strategyInstance, state, req, res): Promise<PerformAuthResult>
Parameters
| Name | Type |
|---|---|
strategyInstance | StrategyInstance |
state | AuthStateServerData & OAuthAuthorizeServerState |
req | any |
res | any |
Returns
Promise<PerformAuthResult>
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:302
toJSON
▸ toJSON(): Object
Returns
Object
| Name | Type |
|---|---|
acceptsVariables | StrategyVariable[] |
allowsImplicitSignup | boolean |
canLoginRegister | boolean |
canSync | boolean |
instanceConfigSchema | Record<string, Schema> |
needsRedirectFlow | boolean |
typeName | string |
updateActions | StrategyUpdateAction[] |
Defined in
gropius-login-service/backend/src/strategies/Strategy.ts:309
updateCapabilityFlags
▸ Private updateCapabilityFlags(parentValue, useDefault, inputValue?): boolean
Parameters
| Name | Type |
|---|---|
parentValue | boolean |
useDefault | boolean |
inputValue? | boolean |
Returns
boolean