Deploying to gh-pages from @ bea0fb6 🚀

Author: achrinza

pages/en/lb4/apidocs/authentication-jwt.myuserservice.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.myuserservice.html
 ```typescript
 export declare class MyUserService implements UserService<User, Credentials> 
 ```
-<b>Implements:</b> [UserService](./authentication.userservice.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, [Credentials](./authentication-jwt.credentials.md)
+<b>Implements:</b> [UserService](./authentication.userservice.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, [Credentials](./authentication-jwt.credentials.md)<!-- -->&gt;
 
 ## Constructors
 

pages/en/lb4/apidocs/authentication-jwt.refreshtokenrepository.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.refreshtokenrepository.html
 ```typescript
 export declare class RefreshTokenRepository extends DefaultCrudRepository<RefreshToken, typeof RefreshToken.prototype.id, RefreshTokenRelations> 
 ```
-<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->, typeof [RefreshToken.prototype.id](./authentication-jwt.refreshtoken.id.md)<!-- -->, [RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)
+<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->, typeof [RefreshToken.prototype.id](./authentication-jwt.refreshtoken.id.md)<!-- -->, [RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)<!-- -->&gt;
 
 ## Constructors
 

pages/en/lb4/apidocs/authentication-jwt.usercredentialsrepository.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.usercredentialsrepository.html
 ```typescript
 export declare class UserCredentialsRepository extends DefaultCrudRepository<UserCredentials, typeof UserCredentials.prototype.id, UserCredentialsRelations> 
 ```
-<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [UserCredentials.prototype.id](./authentication-jwt.usercredentials.id.md)<!-- -->, [UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)
+<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [UserCredentials.prototype.id](./authentication-jwt.usercredentials.id.md)<!-- -->, [UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)<!-- -->&gt;
 
 ## Constructors
 

pages/en/lb4/apidocs/authentication-jwt.userrepository.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.userrepository.html
 ```typescript
 export declare class UserRepository extends DefaultCrudRepository<User, typeof User.prototype.id, UserRelations> 
 ```
-<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->, [UserRelations](./authentication-jwt.userrelations.md)
+<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->, [UserRelations](./authentication-jwt.userrelations.md)<!-- -->&gt;
 
 ## Constructors
 
@@ -30,8 +30,8 @@ export declare class UserRepository extends DefaultCrudRepository<User, typeof U
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [userCredentials](./authentication-jwt.userrepository.usercredentials.md) |  | [HasOneRepositoryFactory](./repository.hasonerepositoryfactory.md)<!-- -->&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->&gt; |  |
-|  [userCredentialsRepositoryGetter](./authentication-jwt.userrepository.usercredentialsrepositorygetter.md) |  | [Getter](./context.getter.md)<!-- -->&lt;[UserCredentialsRepository](./authentication-jwt.usercredentialsrepository.md)<!-- -->&gt; |  |
+|  [userCredentials](./authentication-jwt.userrepository.usercredentials.md) | <code>readonly</code> | [HasOneRepositoryFactory](./repository.hasonerepositoryfactory.md)<!-- -->&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->&gt; |  |
+|  [userCredentialsRepositoryGetter](./authentication-jwt.userrepository.usercredentialsrepositorygetter.md) | <code>protected</code> | [Getter](./context.getter.md)<!-- -->&lt;[UserCredentialsRepository](./authentication-jwt.usercredentialsrepository.md)<!-- -->&gt; |  |
 
 ## Methods
 

pages/en/lb4/apidocs/authentication-passport.strategyadapter.md

@@ -32,7 +32,7 @@ export declare class StrategyAdapter<U> implements AuthenticationStrategy
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./authentication-passport.strategyadapter.name.md) |  | string |  |
+|  [name](./authentication-passport.strategyadapter.name.md) | <code>readonly</code> | string |  |
 
 ## Methods
 

pages/en/lb4/apidocs/authentication.authenticateactionprovider.md

@@ -20,7 +20,7 @@ Provides the authentication action for a sequence
 ```typescript
 export declare class AuthenticateActionProvider implements Provider<AuthenticateFn> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticateFn](./authentication.authenticatefn.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticateFn](./authentication.authenticatefn.md)<!-- -->&gt;
 
 ## Example
 
@@ -39,10 +39,10 @@ context.bind('authentication.actions.authenticate').toProvider(AuthenticateActio
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [getStrategies](./authentication.authenticateactionprovider.getstrategies.md) |  | [Getter](./context.getter.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md) \| [AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined&gt; |  |
-|  [setCurrentUser](./authentication.authenticateactionprovider.setcurrentuser.md) |  | [Setter](./context.setter.md)<!-- -->&lt;[UserProfile](./security.userprofile.md)<!-- -->&gt; |  |
-|  [setRedirectStatus](./authentication.authenticateactionprovider.setredirectstatus.md) |  | [Setter](./context.setter.md)<!-- -->&lt;number&gt; |  |
-|  [setRedirectUrl](./authentication.authenticateactionprovider.setredirecturl.md) |  | [Setter](./context.setter.md)<!-- -->&lt;string&gt; |  |
+|  [getStrategies](./authentication.authenticateactionprovider.getstrategies.md) | <code>readonly</code> | [Getter](./context.getter.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md) \| [AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined&gt; |  |
+|  [setCurrentUser](./authentication.authenticateactionprovider.setcurrentuser.md) | <code>readonly</code> | [Setter](./context.setter.md)<!-- -->&lt;[UserProfile](./security.userprofile.md)<!-- -->&gt; |  |
+|  [setRedirectStatus](./authentication.authenticateactionprovider.setredirectstatus.md) | <code>readonly</code> | [Setter](./context.setter.md)<!-- -->&lt;number&gt; |  |
+|  [setRedirectUrl](./authentication.authenticateactionprovider.setredirecturl.md) | <code>readonly</code> | [Setter](./context.setter.md)<!-- -->&lt;string&gt; |  |
 
 ## Methods
 

pages/en/lb4/apidocs/authentication.authenticationmetadata.md

@@ -23,10 +23,10 @@ export interface AuthenticationMetadata
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [options?](./authentication.authenticationmetadata.options.md) | { \[name: string\]: any; } | <i>(Optional)</i> Options for the authentication strategy |
-|  [skip?](./authentication.authenticationmetadata.skip.md) | boolean | <i>(Optional)</i> A flag to skip authentication |
-|  [strategy](./authentication.authenticationmetadata.strategy.md) | string | Name of the authentication strategy |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [options?](./authentication.authenticationmetadata.options.md) |  | { \[name: string\]: any; } | <i>(Optional)</i> Options for the authentication strategy |
+|  [skip?](./authentication.authenticationmetadata.skip.md) |  | boolean | <i>(Optional)</i> A flag to skip authentication |
+|  [strategy](./authentication.authenticationmetadata.strategy.md) |  | string | Name of the authentication strategy |
 
 

pages/en/lb4/apidocs/authentication.authenticationmiddlewareprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication.authenticationmiddlewareprovider.h
 ```typescript
 export declare class AuthenticationMiddlewareProvider implements Provider<Middleware> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;
 
 ## Constructors
 

pages/en/lb4/apidocs/authentication.authenticationoptions.md

@@ -23,9 +23,9 @@ export interface AuthenticationOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [defaultMetadata?](./authentication.authenticationoptions.defaultmetadata.md) | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] | <i>(Optional)</i> Default authentication metadata if a method or class is not decorated with <code>@authenticate</code>. If not set, no default authentication will be enforced for those methods without authentication metadata. |
-|  [failOnError?](./authentication.authenticationoptions.failonerror.md) | boolean | <i>(Optional)</i> This flag allows an authentication strategy to abort the authentication by throwing an error if <code>failOnError</code> is set to <code>true</code>. By default, the authentication process continues to the next one even when a strategy throws an error. If one of other strategies succeed, the error will be discarded. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [defaultMetadata?](./authentication.authenticationoptions.defaultmetadata.md) |  | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] | <i>(Optional)</i> Default authentication metadata if a method or class is not decorated with <code>@authenticate</code>. If not set, no default authentication will be enforced for those methods without authentication metadata. |
+|  [failOnError?](./authentication.authenticationoptions.failonerror.md) |  | boolean | <i>(Optional)</i> This flag allows an authentication strategy to abort the authentication by throwing an error if <code>failOnError</code> is set to <code>true</code>. By default, the authentication process continues to the next one even when a strategy throws an error. If one of other strategies succeed, the error will be discarded. |
 
 

pages/en/lb4/apidocs/authentication.authenticationstrategy.md

@@ -25,9 +25,9 @@ export interface AuthenticationStrategy
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./authentication.authenticationstrategy.name.md) | string | The 'name' property is a unique identifier for the authentication strategy ( for example : 'basic', 'jwt', etc) |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./authentication.authenticationstrategy.name.md) |  | string | The 'name' property is a unique identifier for the authentication strategy ( for example : 'basic', 'jwt', etc) |
 
 ## Methods
 

pages/en/lb4/apidocs/authentication.authenticationstrategyprovider.md

@@ -22,7 +22,7 @@ It declares an extension point to which all authentication strategy implementati
 ```typescript
 export declare class AuthenticationStrategyProvider implements Provider<AuthenticationStrategy[] | undefined> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined&gt;
 
 ## Example
 
@@ -38,8 +38,8 @@ export declare class AuthenticationStrategyProvider implements Provider<Authenti
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [authenticationStrategies](./authentication.authenticationstrategyprovider.authenticationstrategies.md) |  | [Getter](./context.getter.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\]&gt; |  |
-|  [metadata?](./authentication.authenticationstrategyprovider.metadata.md) |  | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | <i>(Optional)</i> |
+|  [authenticationStrategies](./authentication.authenticationstrategyprovider.authenticationstrategies.md) | <code>protected</code> | [Getter](./context.getter.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\]&gt; |  |
+|  [metadata?](./authentication.authenticationstrategyprovider.metadata.md) | <code>protected</code> | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | <i>(Optional)</i> |
 
 ## Methods
 

pages/en/lb4/apidocs/authentication.authmetadataprovider.md

@@ -20,7 +20,7 @@ Provides authentication metadata of a controller method
 ```typescript
 export declare class AuthMetadataProvider implements Provider<AuthenticationMetadata[] | undefined> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationMetadata](./authentication.authenticationmetadata.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined&gt;
 
 ## Example
 

pages/en/lb4/apidocs/authentication.md

@@ -30,7 +30,7 @@ It contains:
 |  [AuthenticateActionProvider](./authentication.authenticateactionprovider.md) | Provides the authentication action for a sequence |
 |  [AuthenticationComponent](./authentication.authenticationcomponent.md) |  |
 |  [AuthenticationMiddlewareProvider](./authentication.authenticationmiddlewareprovider.md) |  |
-|  [AuthenticationStrategyProvider](./authentication.authenticationstrategyprovider.md) | An authentication strategy provider responsible for resolving an authentication strategy by name.<!-- -->It declares an extension point to which all authentication strategy implementations must register themselves as extensions. |
+|  [AuthenticationStrategyProvider](./authentication.authenticationstrategyprovider.md) | <p>An authentication strategy provider responsible for resolving an authentication strategy by name.</p><p>It declares an extension point to which all authentication strategy implementations must register themselves as extensions.</p> |
 |  [AuthMetadataProvider](./authentication.authmetadataprovider.md) | Provides authentication metadata of a controller method |
 
 ## Functions
@@ -49,11 +49,11 @@ It contains:
 |  [AuthenticateFn](./authentication.authenticatefn.md) | interface definition of a function which accepts a request and returns an authenticated user |
 |  [AuthenticationMetadata](./authentication.authenticationmetadata.md) | Authentication metadata stored via Reflection API |
 |  [AuthenticationOptions](./authentication.authenticationoptions.md) | Options for authentication component |
-|  [AuthenticationStrategy](./authentication.authenticationstrategy.md) | An interface that describes the common authentication strategy.<!-- -->An authentication strategy is a class with an 'authenticate' method that verifies a user's credentials and returns the corresponding user profile. |
+|  [AuthenticationStrategy](./authentication.authenticationstrategy.md) | <p>An interface that describes the common authentication strategy.</p><p>An authentication strategy is a class with an 'authenticate' method that verifies a user's credentials and returns the corresponding user profile.</p> |
 |  [TokenService](./authentication.tokenservice.md) | An interface for generating and verifying a token |
 |  [UserIdentityService](./authentication.useridentityservice.md) | The User Identity service links a user to profiles from an external source (eg: ldap, oauth2 provider, saml) which can identify the user. The profile typically has the following information: name, email-id, uuid, roles, authorizations, scope of accessible resources, expiration time for given access |
 |  [UserProfileFactory](./authentication.userprofilefactory.md) | interface definition of a factory function which accepts a user definition and returns the user profile |
-|  [UserService](./authentication.userservice.md) | A service for performing the login action in an authentication strategy.<!-- -->Usually a client user uses basic credentials to login, or is redirected to a third-party application that grants limited access.<!-- -->Note: The creation of user is handled in the user controller by calling user repository APIs. For Basic auth, the user has to register first using some endpoint like <code>/register</code>. For 3rd-party auth, the user will be created if login is successful and the user doesn't exist in database yet.<!-- -->Type <code>C</code> stands for the type of your credential object.<!-- -->- For local strategy:<!-- -->A typical credential would be: { username: username, password: password }<!-- -->- For oauth strategy:<!-- -->A typical credential would be: { clientId: string; clientSecret: string; callbackURL: string; }<!-- -->It could be read from a local configuration file in the app<!-- -->- For saml strategy:<!-- -->A typical credential would be:<!-- -->{ path: string; issuer: string; entryPoint: string; }<!-- -->It could be read from a local configuration file in the app. |
+|  [UserService](./authentication.userservice.md) | <p>A service for performing the login action in an authentication strategy.</p><p>Usually a client user uses basic credentials to login, or is redirected to a third-party application that grants limited access.</p><p>Note: The creation of user is handled in the user controller by calling user repository APIs. For Basic auth, the user has to register first using some endpoint like <code>/register</code>. For 3rd-party auth, the user will be created if login is successful and the user doesn't exist in database yet.</p><p>Type <code>C</code> stands for the type of your credential object.</p><p>- For local strategy:</p><p>A typical credential would be: { username: username, password: password }</p><p>- For oauth strategy:</p><p>A typical credential would be: { clientId: string; clientSecret: string; callbackURL: string; }</p><p>It could be read from a local configuration file in the app</p><p>- For saml strategy:</p><p>A typical credential would be:</p><p>{ path: string; issuer: string; entryPoint: string; }</p><p>It could be read from a local configuration file in the app.</p> |
 
 ## Namespaces