internals | @dvelop-sdk

Index

Functions Authentication

Functions Http

Authentication Functions

_getAuthSessionDefaultTransformFunction

_getAuthSessionDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext): AuthSession

- Defined in packages/identityprovider/src/authentication/get-auth-session/get-auth-session.ts:20
Default transform-function provided to the getAuthSession-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
Returns AuthSession

_getAuthSessionFactory

_getAuthSessionFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext) => T): (context: DvelopContext) => Promise<T>

- Defined in packages/identityprovider/src/authentication/get-auth-session/get-auth-session.ts:33
Factory for the getAuthSession-function. See internals for more information. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getAuthSession-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      Returns T
Returns (context: DvelopContext) => Promise<T>
- - (context: DvelopContext): Promise<T>
  - Factory for the getAuthSession-function. See internals for more information. See Advanced Topics for more information.
    
    internal
    category
    Authentication
    
    Parameters
    - context: DvelopContext
    Returns Promise<T>

_getImpersonatedAuthSessionIdDefaultTransformFunction

_getImpersonatedAuthSessionIdDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext, __: GetImpersonatedAuthSessionIdParams): string

- Defined in packages/identityprovider/src/authentication/get-impersonated-auth-session-id/get-impersonated-auth-session-id.ts:17
Default transform-function provided to the {@link getImpersontedAuthSessionId}-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- __: GetImpersonatedAuthSessionIdParams
Returns string

_getImpersonatedAuthSessionIdFactory

_getImpersonatedAuthSessionIdFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => T): (context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => Promise<T>

- Defined in packages/identityprovider/src/authentication/get-impersonated-auth-session-id/get-impersonated-auth-session-id.ts:27
Factory for the getImpersonatedAuthSessionId}-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getImpersonatedAuthSessionId-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetImpersonatedAuthSessionIdParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: GetImpersonatedAuthSessionIdParams
      Returns T
Returns (context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => Promise<T>
- - (context: DvelopContext, params: GetImpersonatedAuthSessionIdParams): Promise<T>
  - Factory for the getImpersonatedAuthSessionId}-function. See Advanced Topics for more information.
    
    internal
    category
    Authentication
    
    Parameters
    - context: DvelopContext
    - params: GetImpersonatedAuthSessionIdParams
    Returns Promise<T>

_requestAppSessionFactory

_requestAppSessionFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: RequestAppSessionParams) => T): (context: DvelopContext, params: RequestAppSessionParams) => Promise<T>

- Defined in packages/identityprovider/src/authentication/request-app-session/request-app-session.ts:20
Factory for the requestAppSession-function. See Advanced Topics for more information.

Type parameters
- T
  
  Return type of the requestAppSession-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: RequestAppSessionParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: RequestAppSessionParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: RequestAppSessionParams
      Returns T
Returns (context: DvelopContext, params: RequestAppSessionParams) => Promise<T>
- - (context: DvelopContext, params: RequestAppSessionParams): Promise<T>
  - Factory for the requestAppSession-function. See Advanced Topics for more information.
    
    category
    Authentication
    
    Parameters
    - context: DvelopContext
    - params: RequestAppSessionParams
    Returns Promise<T>

_validateAuthSessionIdDefaultTransformFunction

_validateAuthSessionIdDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext): DvelopUser

- Defined in packages/identityprovider/src/authentication/validate-auth-session-id/validate-auth-session-id.ts:48
Default transform-function provided to the validateAuthSessionId-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
Returns DvelopUser

_validateAuthSessionIdFactory

_validateAuthSessionIdFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext) => T): (context: DvelopContext) => Promise<T>

- Defined in packages/identityprovider/src/authentication/validate-auth-session-id/validate-auth-session-id.ts:57
Factory for the validateAuthSessionId-function. See Advanced Topics for more information.

Type parameters
- T
  
  Return type of the validateAuthSessionId-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      Returns T
Returns (context: DvelopContext) => Promise<T>
- - (context: DvelopContext): Promise<T>
  - Factory for the validateAuthSessionId-function. See Advanced Topics for more information.
    
    category
    Authentication
    
    Parameters
    - context: DvelopContext
    Returns Promise<T>

Http Functions

_defaultHttpRequestFunction

_defaultHttpRequestFunction(context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse>

- Defined in packages/identityprovider/src/utils/http.ts:61
Default httpRequestFunction used in dms-package.

internal
Parameters
- context: DvelopContext
- config: DvelopHttpRequestConfig<any>
Returns Promise<DvelopHttpResponse>

_defaultHttpRequestFunctionFactory

_defaultHttpRequestFunctionFactory(httpClient: DvelopHttpClient): (context: DvelopContext, config: DvelopHttpRequestConfig) => Promise<DvelopHttpResponse>

- Defined in packages/identityprovider/src/utils/http.ts:23
Factory used to create the default httpRequestFunction. Mostly used for HTTP-Error handling.

internal
Parameters
- httpClient: DvelopHttpClient
Returns (context: DvelopContext, config: DvelopHttpRequestConfig) => Promise<DvelopHttpResponse>
- - (context: DvelopContext, config: DvelopHttpRequestConfig): Promise<DvelopHttpResponse>
  - Factory used to create the default httpRequestFunction. Mostly used for HTTP-Error handling.
    
    internal
    category
    Http
    
    Parameters
    - context: DvelopContext
    - config: DvelopHttpRequestConfig
    Returns Promise<DvelopHttpResponse>

Index

Functions Authentication

Functions Http

Authentication Functions

_getAuthSessionDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

_: DvelopContext

Returns AuthSession

_getAuthSessionFactory

Type parameters

T

Parameters

httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

Returns T

Returns (context: DvelopContext) => Promise<T>

Parameters

context: DvelopContext

Returns Promise<T>

_getImpersonatedAuthSessionIdDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

_: DvelopContext

__: GetImpersonatedAuthSessionIdParams

Returns string

_getImpersonatedAuthSessionIdFactory

Type parameters

T

Parameters

httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: GetImpersonatedAuthSessionIdParams

Returns T

Returns (context: DvelopContext, params: GetImpersonatedAuthSessionIdParams) => Promise<T>

Parameters

context: DvelopContext

params: GetImpersonatedAuthSessionIdParams

Returns Promise<T>

_requestAppSessionFactory

Type parameters

T

Parameters

httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: RequestAppSessionParams) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: RequestAppSessionParams

Returns T

Returns (context: DvelopContext, params: RequestAppSessionParams) => Promise<T>

Parameters

context: DvelopContext

params: RequestAppSessionParams

Returns Promise<T>

_validateAuthSessionIdDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

_: DvelopContext

Returns DvelopUser

_validateAuthSessionIdFactory

Type parameters