@loopback/docs 4.0.4 → 5.1.1

package/site/ReferencesMany-relation.md

@@ -0,0 +1,379 @@
+---
+lang: en
+title: 'referencesMany Relation'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Model Relation
+sidebar: lb4_sidebar
+permalink: /doc/en/lb4/ReferencesMany-relation.html
+---
+
+## Overview
+
+{% include important.html content="Please read [Relations](Relations.md) first." %}
+
+LoopBack relations enable you to create connections between models and provide
+navigation APIs to deal with a graph of model instances. In addition to the
+traditional ones, LoopBack supports `referencesMany` relation that embeds an
+array of foreign keys to reference other objects. For example:
+
+```json
+{
+  "id": 1,
+  "name": "John Smith",
+  "accountIds": ["saving-01", "checking-01"]
+}
+```
+
+To add a `referencesMany` relation to your LoopBack application, you need to
+perform the following steps:
+
+1. Add a property to your source model to define the array of foreign keys.
+2. Modify the source model repository class to provide an accessor function for
+   obtaining the target model instances.
+3. Call the accessor function in your controller methods.
+
+## Defining a referencesMany relation
+
+This section describes how to define a `referencesMany` relation at the model
+level using the `@referencesMany` decorator to define the array of foreign keys.
+
+LB4 also provides an CLI tool `lb4 relation` to generate `referencesMany`
+relation for you. Before you check out the
+[`Relation Generator`](https://loopback.io/doc/en/lb4/Relation-generator.html)
+page, read on to learn how you can define relations to meet your requirements.
+
+### Relation Metadata
+
+LB4 uses three `keyFrom`, `keyTo` and `name` fields in the `referencesMany`
+relation metadata to configure relations. The relation metadata has its own
+default values for these three fields:
+
+<table>
+  <thead>
+    <tr>
+      <th width="95">Field Name</th>
+      <th width="260">Description</th>
+      <th width="260">Default Value</th>
+      <th>Example</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>keyFrom</code></td>
+      <td>the array property of foreign keys</td>
+      <td>the target model name appended with `Ids` in camel case</td>
+      <td><code>Customer.accountIds</code></td>
+    </tr>
+    <tr>
+      <td><code>keyTo</code></td>
+      <td>the source key of the target model</td>
+      <td>the primary key in the target model</td>
+      <td><code>Account.id</code></td>
+    </tr>
+    <tr>
+      <td><code>name</code></td>
+      <td>the name of the relation</td>
+      <td>the plural name of target model</td>
+      <td><code>accounts</code></td>
+    </tr>
+
+  </tbody>
+</table>
+
+We recommend to use default values. If you'd like to customize the name of
+foreign keys or the relation name, you'll need to specify some fields through
+the relation decorator.
+
+The standard naming convention for the property of foreign keys in the source
+model is `target name` + `Ids` (for example, Customer.accountIds).
+
+{% include code-caption.html content="/src/models/customer.model.ts" %}
+
+```ts
+import {referencesMany, Entity, model, property} from '@loopback/repository';
+import {Account} from './account.model';
+
+@model()
+export class Customer extends Entity {
+  @property({
+    type: 'number',
+    id: true,
+  })
+  id: number;
+
+  @property({
+    type: 'string',
+  })
+  name: string;
+
+  @referencesMany(() => Account)
+  accountIds: number[]; // relation name will default to `accounts`
+
+  constructor(data: Partial<Customer>) {
+    super(data);
+  }
+}
+
+export interface CustomerRelations {
+  // describe navigational properties here
+}
+
+export type CustomerWithRelations = Customer & CustomerRelations;
+```
+
+If the property name of foreign keys in the source model has to be customized
+(`account_ids` instead of `accountIds` for example), the relation name has to be
+explicitly specified in the `name` attribute of the relation definition.
+Otherwise the _default relation name_ generates by LB4 (`account_ids` in this
+case) will be the same as the customized name of foreign keys, which is invalid.
+
+{% include warning.html content="Make sure that you have different names for the property name of foreign keys and the relation name in ReferencesMany relations."%}
+
+```ts
+// import statements
+@model()
+export class Customer extends Entity {
+  @property({
+    type: 'number',
+    id: true,
+  })
+  id: number;
+
+  @property({
+    type: 'string',
+  })
+  name: string;
+
+  @referencesMany(
+    () => Account,
+    {name: 'accounts'}, // specify the relation name if fk is customized
+  )
+  account_ids: number[]; // customized foreign keys
+
+  // other properties, constructor, etc.
+}
+```
+
+If you need to use _different names for models and database columns_, to use
+`account_ids` as db column name other than `accountIds` for example, passing the
+column name in the third argument to the `referencesMany` decorator would allow
+you to do so:
+
+```ts
+class Customer extends Entity {
+  // constructor, properties, etc.
+  @referencesMany(() => Account, {keyFrom: 'accountIds'}, {name: 'account_ids'})
+  accountIds: number[];
+}
+```
+
+If you need to use another attribute other than the id property to be the source
+key of the target model (joining two tables on non-primary attribute), the
+`keyTo` attribute in the relation definition has to be stated explicitly.
+
+```ts
+class Customer extends Entity {
+  // constructor, properties, etc.
+  @referencesMany(() => Account, {keyTo: 'customized_target_property'})
+  accountIds: number[];
+}
+
+export interface CustomerRelations {
+  accounts?: AccountWithRelations[];
+}
+```
+
+{% include important.html content="LB4 doesn't support composite keys for now. e.g joining two tables with more than one source key. Related GitHub issue: [Composite primary/foreign keys](https://github.com/loopbackio/loopback-next/issues/1830)" %}
+
+## Configuring a referencesMany relation
+
+The configuration and resolution of a `referencesMany` relation takes place at
+the repository level. Once `referencesMany` relation is defined on the source
+model, then there are a couple of steps involved to configure it and use it. On
+the source repository, the following are required:
+
+- In the constructor of your source repository class, use
+  [Dependency Injection](Dependency-injection.md) to receive a getter function
+  for obtaining an instance of the target repository.
+- Declare a property with the factory function type
+  `ReferencesManyAccessor<targetModel, typeof sourceModel.prototype.id>` on the
+  source repository class.
+- call the `createReferencesManyAccessorFor` function in the constructor of the
+  source repository class with the relation name (decorated relation property on
+  the source model) and target repository instance and assign it the property
+  mentioned above.
+
+The following code snippet shows how it would look like:
+
+{% include code-caption.html
+content="/src/repositories/customer.repository.ts" %}
+
+```ts
+import {Getter, inject} from '@loopback/core';
+import {
+  ReferencesManyAccessor,
+  DefaultCrudRepository,
+  juggler,
+  repository,
+} from '@loopback/repository';
+import {Account, Customer, CustomerRelations} from '../models';
+import {AccountRepository} from '../repositories';
+
+export class CustomerRepository extends DefaultCrudRepository<
+  Customer,
+  typeof Customer.prototype.id,
+  CustomerRelations
+> {
+  public readonly accounts: ReferencesManyAccessor<
+    Account,
+    typeof Customer.prototype.id
+  >;
+
+  constructor(
+    @inject('datasources.db') protected db: juggler.DataSource,
+    @repository.getter('AccountRepository')
+    accountRepositoryGetter: Getter<AccountRepository>,
+  ) {
+    super(Customer, db);
+    this.accounts = this.createReferencesManyAccessorFor(
+      'accounts',
+      accountRepositoryGetter,
+    );
+  }
+}
+```
+
+`ReferencesManyAccessor` is a function accepting the primary key (id) of a
+source model instance (e.g. `customer.id`) and returning back the related target
+model instances (e.g. a `Account[]`). See also
+[API Docs](https://loopback.io/doc/en/lb4/apidocs.repository.belongstoaccessor.html)
+
+{% include note.html content="Notice that `CustomerRepository.create()` expects an `Customer` model only, navigational properties are not expected to be included in the target data. For instance, the following request will be rejected:
+`customerRepository.create({`
+`  id: 1,`
+`  name: 'John'`
+`  accountIds: [1]`
+`  accounts:[{id: 1, balance: 0}] // rejected`
+`})`" %}
+
+## Querying related models
+
+Different from LB3, LB4 creates a different inclusion resolver for each relation
+type to query related models. Each **relation** has its own inclusion resolver
+`inclusionResolver`. And each **repository** has a built-in property
+`inclusionResolvers` as a registry for its inclusionResolvers.
+
+A `referencesMany` relation has an `inclusionResolver` function as a property.
+It fetches target models for the given list of source model instances.
+
+### Use the relation between `Customer` and `Account` we show above.
+
+After setting up the relation in the repository class, the inclusion resolver
+allows users to retrieve all customers along with their related accounts through
+the following code at the repository level:
+
+```ts
+customerRepo.find({include: ['accounts']});
+```
+
+or use APIs with controllers:
+
+```
+GET http://localhost:3000/customers?filter[include][]=accounts
+```
+
+### Enable/disable the inclusion resolvers
+
+- Base repository classes have a public property `inclusionResolvers`, which
+  maintains a map containing inclusion resolvers for each relation.
+- The `inclusionResolver` of a certain relation is built when the source
+  repository class calls the `createReferencesManyAccessorFor` function in the
+  constructor with the relation name.
+- Call `registerInclusionResolver` to add the resolver of that relation to the
+  `inclusionResolvers` map. (As we realized in LB3, not all relations are
+  allowed to be traversed. Users can decide to which resolvers can be added.)
+  The first parameter is the name of the relation.
+
+The following code snippet shows how to register the inclusion resolver for the
+referencesMany relation 'accounts':
+
+```ts
+export class CustomerRepository extends DefaultCrudRepository {
+  accounts: ReferencesManyAccessor<Account, typeof Customer.prototype.id>;
+
+  constructor(
+    dataSource: juggler.DataSource,
+    accountRepositoryGetter: Getter<AccountRepository>,
+  ) {
+    super(Customer, dataSource);
+
+    // we already have this line to create a ReferencesManyRepository factory
+    this.accounts = this.createReferencesManyAccessorFor(
+      'accounts',
+      accountRepositoryGetter,
+    );
+
+    // add this line to register inclusion resolver.
+    this.registerInclusionResolver('accounts', this.accounts.inclusionResolver);
+  }
+}
+```
+
+- We can simply include the relation in queries via `find()`, `findOne()`, and
+  `findById()` methods. For example, these queries return all customers with
+  their accounts:
+
+  if you process data at the repository level:
+
+  ```ts
+  customerRepository.find({include: ['accounts']});
+  ```
+
+  this is the same as the url:
+
+  ```
+  GET http://localhost:3000/customers?filter[include][]=accounts
+  ```
+
+  which returns:
+
+  ```ts
+  [
+    {
+      id: 1,
+      name: 'John',
+      accountIds: [12, 16],
+      accounts: [
+        {
+          id: 12,
+          balance: 99,
+        },
+        {
+          id: 16,
+          balance: 0,
+        },
+      ],
+    },
+    {
+      id: 2,
+      name: 'Dave',
+      accountIds: [4],
+      accounts: [
+        {
+          id: 4,
+          balance: 10,
+        },
+      ],
+    },
+  ];
+  ```
+
+- You can delete a relation from `inclusionResolvers` to disable the inclusion
+  for a certain relation. e.g
+  `customerRepository.inclusionResolvers.delete('accounts')`
+
+### Query multiple relations
+
+It is possible to query several relations or nested include relations with
+custom scope once you have the inclusion resolver of each relation set up. Check
+[HasMany - Query multiple relations](HasMany-relation.md#query-multiple-relations)
+for the usage and examples.

package/site/Relation-generator.md

@@ -138,6 +138,7 @@ The tool will prompt you for:
   - [HasManyThrough](HasManyThrough-relation.md)
   - [HasOne](HasOne-relation.md)
   - [BelongsTo](BelongsTo-relation.md)
+  - [ReferencesMany](ReferencesMany-relation.md)
 
 - Name of the source model (`sourceModel`). Prompts a list of available models
   to choose from as the source model of the relation.

package/site/Relations.md

@@ -45,6 +45,7 @@ Here are the currently supported relations:
 - [BelongsTo](BelongsTo-relation.md)
 - [HasOne](HasOne-relation.md)
 - [HasManyThrough](HasManyThrough-relation.md)
+- [ReferencesMany](ReferencesMany-relation.md)
 
 {% include note.html content="
 The `hasMany` relation may alternatively be implemented using the

package/site/Repository-generator.md

@@ -62,7 +62,7 @@ model already created in their respective directories.
 
 ### Arguments
 
-`<name>` - Optional argument specifyng the respository name to be generated. In
+`<name>` - Optional argument specifying the repository name to be generated. In
 case you select multiple models, the first model will take this argument for its
 repository file name.
 
@@ -91,7 +91,7 @@ The tool will prompt you for:
 - **Please select the repository base class.** _(repository)_ if the name of a
   valid base class has been supplied from the command line, the prompt is
   skipped, otherwise it will present you a list of repositories. The default
-  repository is infered from the datasource type.
+  repository is inferred from the datasource type.
 
   Any repository in the `src/repository` folder with the file format
   `*.repository.base.ts` will be added to the list too.

package/site/Repository.md

@@ -105,7 +105,7 @@ When a `DataSource` is instantiated, the configuration properties will be used
 to initialize the connector to connect to the backend system. You can define a
 DataSource using Juggler in your LoopBack 4 app as follows:
 
-{% include code-caption.html content="src/datsources/db.datasource.ts" %}
+{% include code-caption.html content="src/datasources/db.datasource.ts" %}
 
 ```ts
 import {juggler} from '@loopback/repository';

package/site/Request-response-cycle.md

@@ -13,7 +13,7 @@ the APIs that create the endpoints on the server. We will then follow the path
 taken by a request, to see how it makes its way through the various parts of the
 framework to return a result.
 
-### Setting up the request/response infrastruture
+### Setting up the request/response infrastructure
 
 The endpoints on a LoopBack app can be categorized into controller endpoints and
 non-controller endpoints. Controller endpoints are those that are created by
@@ -30,7 +30,7 @@ controller method.
 {% include tip.html content="Apart from controller files in the `controllers` directory,
 controllers may be added to the app by [components](https://loopback.io/doc/en/lb4/Components.html)." %}
 
-In the request/response cycle section we will see how implemenation details
+In the request/response cycle section we will see how implementation details
 determine the course of a request to these endpoints - they may or may not
 actually interact with a model.
 
@@ -116,7 +116,7 @@ route for invocation.
 ##### 2. ParseParams
 
 [ParseParams](https://loopback.io/doc/en/lb4/apidocs.rest.parseparamsprovider.html)
-parses LoopBack-relevant request paremeters from the request body, URL segment,
+parses LoopBack-relevant request parameters from the request body, URL segment,
 and query parameters.
 
 It is also responsible for validating the property types of the request body, as
@@ -127,7 +127,7 @@ HTTP 422 error.
 
 [InvokeMethod](https://loopback.io/doc/en/lb4/apidocs.rest.invokemethodprovider.html)
 is responsible for calling the endpoint handler, passing in the route found by
-`FindRoute` and the paremeters found by `ParseParams`.
+`FindRoute` and the parameters found by `ParseParams`.
 
 For non-controller endpoints, control is passed on to the respective handlers at
 this stage, which may then handle the response sending process themselves. For
@@ -234,8 +234,8 @@ use them.
 between controllers and the data. They use an underlying datasource and a
 connector to interact with the data.
 
-Controller methods can call corresponding methods in the respository to read
-from or write to the database.
+Controller methods can call corresponding methods in the repository to read from
+or write to the database.
 
 Repositories can be injected in the controller constructor so controller methods
 may use them.

package/site/Rest-Crud-generator.md

@@ -27,6 +27,8 @@ src/datasources
 
 `--basePath` : _(Optional)_ base path of the model endpoint
 
+`--readonly` : _(Optional)_ create readonly APIs e.g find and count
+
 ### Configuration file
 
 This generator supports a config file with the following format, see the
@@ -37,7 +39,8 @@ file.
 {
   "datasource": "validDataSourceName",
   "model": "validModelName",
-  "basePath": "/<base-path>"
+  "basePath": "/<base-path>",
+  "readonly": "<boolean>"
 }
 ```
 
@@ -74,6 +77,9 @@ The tool will prompt you for:
   supplied from the command line with `--basePath` option or more than one
   models are selected, the prompt is skipped.
 
+- **Create readonly APIs.** _(readonly)_ If readonly had been supplied from the
+  command line with `--readonly` option, the prompt is skipped.
+
 ### Output
 
 Once all the prompts have been answered, the CLI will do the following for each

package/site/Serving-static-files.md

@@ -43,7 +43,7 @@ export class TodoListApplication extends BootMixin(
 ```
 
 You can call `app.static()` multiple times to configure the app to serve static
-assets from different drectories.
+assets from different directories.
 
 ```ts
 app.static('/files', path.join(__dirname, 'files'));

package/site/Testing-your-application.md

@@ -970,7 +970,7 @@ describe('Product (acceptance)', () => {
     await app.boot();
 
     // change to use the test datasource after the app has been booted so that
-    // it is not overriden
+    // it is not overridden
     app.dataSource(testdb);
     await app.start();
 

package/site/apidocs/apiconnect.apiconnectspecenhancer._constructor_.md

@@ -26,6 +26,6 @@ constructor(options: ApiConnectSpecOptions, appMetadata?: ApplicationMetadata);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  options | [ApiConnectSpecOptions](./apiconnect.apiconnectspecoptions.md) |  |
-|  appMetadata | [ApplicationMetadata](./core.applicationmetadata.md) |  |
+|  appMetadata | [ApplicationMetadata](./core.applicationmetadata.md) | <i>(Optional)</i> |
 
 

package/site/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)<!-- -->&gt;
+<b>Implements:</b> [UserService](./authentication.userservice.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, [Credentials](./authentication-jwt.credentials.md)
 
 ## Constructors
 

package/site/apidocs/authentication-jwt.refreshtoken._constructor_.md

@@ -25,6 +25,6 @@ constructor(data?: Partial<RefreshToken>);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | Partial&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->&gt; |  |
+|  data | Partial&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 

package/site/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)<!-- -->&gt;
+<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)
 
 ## Constructors
 

package/site/apidocs/authentication-jwt.user._constructor_.md

@@ -25,6 +25,6 @@ constructor(data?: Partial<User>);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | Partial&lt;[User](./authentication-jwt.user.md)<!-- -->&gt; |  |
+|  data | Partial&lt;[User](./authentication-jwt.user.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication-jwt.usercredentials._constructor_.md

@@ -25,6 +25,6 @@ constructor(data?: Partial<UserCredentials>);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | Partial&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->&gt; |  |
+|  data | Partial&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 

package/site/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)<!-- -->&gt;
+<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)
 
 ## Constructors
 

package/site/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)<!-- -->&gt;
+<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)
 
 ## Constructors
 

package/site/apidocs/authentication-passport.strategyadapter._constructor_.md

@@ -27,6 +27,6 @@ constructor(strategy: Strategy, name: string, userProfileFactory?: UserProfileFa
 |  --- | --- | --- |
 |  strategy | Strategy | instance of a class which implements a [passport-strategy](http://passportjs.org/)<!-- -->. |
 |  name | string |  |
-|  userProfileFactory | [UserProfileFactory](./authentication.userprofilefactory.md)<!-- -->&lt;U&gt; |  |
+|  userProfileFactory | [UserProfileFactory](./authentication.userprofilefactory.md)<!-- -->&lt;U&gt; | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication-passport.strategyadapter.authenticate.md

@@ -26,7 +26,7 @@ authenticate(request: Request, options?: AuthenticateOptions): Promise<UserProfi
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  request | Request | The incoming request. |
-|  options | AuthenticateOptions | Options passed through to strategy.authenticate. |
+|  options | AuthenticateOptions | <i>(Optional)</i> Options passed through to strategy.authenticate. |
 
 <b>Returns:</b>
 

package/site/apidocs/authentication.authenticateactionprovider._constructor_.md

@@ -29,6 +29,6 @@ constructor(getStrategies: Getter<AuthenticationStrategy | AuthenticationStrateg
 |  setCurrentUser | [Setter](./context.setter.md)<!-- -->&lt;[UserProfile](./security.userprofile.md)<!-- -->&gt; |  |
 |  setRedirectUrl | [Setter](./context.setter.md)<!-- -->&lt;string&gt; |  |
 |  setRedirectStatus | [Setter](./context.setter.md)<!-- -->&lt;number&gt; |  |
-|  options | [AuthenticationOptions](./authentication.authenticationoptions.md) |  |
+|  options | [AuthenticationOptions](./authentication.authenticationoptions.md) | <i>(Optional)</i> |
 
 

package/site/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)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticateFn](./authentication.authenticatefn.md)
 
 ## Example
 

package/site/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)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)
 
 ## Constructors
 

package/site/apidocs/authentication.authenticationstrategyprovider._constructor_.md

@@ -26,6 +26,6 @@ constructor(authenticationStrategies: Getter<AuthenticationStrategy[]>, metadata
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  authenticationStrategies | [Getter](./context.getter.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\]&gt; |  |
-|  metadata | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined |  |
+|  metadata | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | <i>(Optional)</i> |
 
 

package/site/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)<!-- -->\[\] \| undefined&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)
 
 ## Example